ProxyCommand.GetHelpComments Method

Definition

Construct the text that can be used in a multi-line comment for get-help.

public static string GetHelpComments (System.Management.Automation.PSObject help);
Parameters
help
PSObject

A custom PSObject created by Get-Help.

Returns

A string that can be used as the help comment for script for the input HelpInfo object.

Exceptions

When the help argument is null.

When the help argument is not recognized as a HelpInfo object.