Task.HelpKeywordPrefix Property

Definition

Namespace:

Microsoft.Build.Utilities

Assembly:

Microsoft.Build.Utilities.Core.dll

Package:

Microsoft.Build.Utilities.Core v17.9.5

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

protected:
 property System::String ^ HelpKeywordPrefix { System::String ^ get(); void set(System::String ^ value); };

protected string HelpKeywordPrefix { get; set; }

member this.HelpKeywordPrefix : string with get, set

Protected Property HelpKeywordPrefix As String

Property Value

String

The help keyword prefix string (can be null).

Remarks

If a task does not have Help keywords associated with its messages, it can ignore this property or set it to null. If this property is set to an empty String, resource names will be used verbatim as Help keywords.