ParameterSetMetadata.HelpMessageResourceId Property

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Gets and sets the resource identifier of the Help message of the parameter for this parameter set. This identifier is typically used when localizing the message. This property is introduced in Windows PowerShell 2.0.

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

public string HelpMessageResourceId { get; set; }

Property Value

Type: System.String

A String object that contains the resource identifier of the Help message of the parameter for this parameter set. This identifier is typically used when localizing the message. These Help messages are used primarily for prompting for mandatory parameters. They are displayed when the command is run, and they do 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: