ParameterSetMetadata.HelpMessage Property

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Gets and sets the Help message that describes the parameter for this parameter set. This property is introduced in Windows PowerShell 2.0.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

public string HelpMessage { get; set; }

Property Value

Type: System.String

A String object that contains the Help message that describes the parameter for this parameter set. This Help message is used primarily for prompting for mandatory parameters. It is displayed when the command is run, and it does not show up when the Get-Help cmdlet is run.

The information provided by this class is accessed through the ParameterMetadata.ParameterSets property.

For more information about declaring parameters, see Parameter Attribute Declaration.

For more information about cmdlet parameters, see Cmdlet Parameters.

Return to top

Community Additions

ADD
Show: