ICmdletProviderSupportsHelp.GetHelpMaml(String, String) Method

  • Reference

Definition

Namespace:
System.Management.Automation.Provider
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Called by the help system to get provider-specific help from the provider.

public:
 System::String ^ GetHelpMaml(System::String ^ helpItemName, System::String ^ path);
public:
 Platform::String ^ GetHelpMaml(Platform::String ^ helpItemName, Platform::String ^ path);
std::wstring GetHelpMaml(std::wstring const & helpItemName, std::wstring const & path);
public string GetHelpMaml (string helpItemName, string path);
abstract member GetHelpMaml : string * string -> string
Public Function GetHelpMaml (helpItemName As String, path As String) As String

Parameters

helpItemName
String

Name of command that the help is requested for.

path
String

Full path to the current location of the user or the full path to the location of the property that the user needs help about.

Returns

String

The MAML help XML that should be presented to the user.

Applies to