Share via

ParameterAttribute.HelpMessage Property

  • 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

Gets or sets a short description for this parameter, suitable for presentation as a tool tip.

public:
 property System::String ^ HelpMessage { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ HelpMessage { Platform::String ^ get(); void set(Platform::String ^ value); };
public string HelpMessage { get; set; }
member this.HelpMessage : string with get, set
Public Property HelpMessage As String

Property Value

String

Exceptions

ArgumentException

For a null or empty value when setting.

Applies to