ProxyCommand.GetHelpComments(PSObject) Method

Reference

Definition

Namespace:: System.Management.Automation

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 static System::String ^ GetHelpComments(System::Management::Automation::PSObject ^ help);

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

static member GetHelpComments : System.Management.Automation.PSObject -> string

Public Shared Function GetHelpComments (help As PSObject) As String

Parameters

help: PSObject

A custom PSObject created by Get-Help.

Returns

String

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

Exceptions

ArgumentNullException

When the help argument is null.

InvalidOperationException

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

Applies to