FieldDescription.HelpMessage Property

Definition

Namespace:

System.Management.Automation.Host

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Gets and sets the help message for this field.

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

PSArgumentNullException

Set to null.

Remarks

This should be a few sentences to describe the field, suitable for presentation as a tool tip. Avoid placing including formatting characters such as newline and tab.