TaskLoggingHelper.ExtractMessageCode(String, String) Method

Reference

Definition

Namespace:: Microsoft.Build.Utilities

Assembly:: Microsoft.Build.Utilities.Core.dll

Assembly:: Microsoft.Build.Utilities.dll

Assemblies:: Microsoft.Build.Utilities.dll, Microsoft.Build.Utilities.v3.5.dll

Assembly:: Microsoft.Build.Utilities.v4.0.dll

Package:: Microsoft.Build.Utilities.Core v15.9.20

Package:: Microsoft.Build.Utilities.Core v16.11.0

Package:: Microsoft.Build.Utilities.Core v17.9.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Extracts the message code (if any) prefixed to the given message string. Message code prefixes must match the following .NET regular expression in order to be recognized: ^\s*[A-Za-z]+\d+:\s* Thread safe.

public:
 System::String ^ ExtractMessageCode(System::String ^ message, [Runtime::InteropServices::Out] System::String ^ % messageWithoutCodePrefix);

public string ExtractMessageCode (string message, out string messageWithoutCodePrefix);

member this.ExtractMessageCode : string * string -> string

Public Function ExtractMessageCode (message As String, ByRef messageWithoutCodePrefix As String) As String

Parameters

message: String

The message to parse.

messageWithoutCodePrefix: String

The message with the code prefix removed (if any).

Returns

String

The message code extracted from the prefix, or null if there was no code.

Exceptions

ArgumentNullException

Thrown when message is null.

Examples

If this method is given the full message string MYTASK1001: This is an error message. and it accepts This is an error message. as the value for the messageWithoutCodePrefix parameter, then it returns MYTASK1001.

If this method is given the string "MYTASK1001: This is an error message.", it will return "MYTASK1001" for the message code, and "This is an error message." for the message.

Remarks

Message code prefixes must match the following .NET regular expressions in order to be recognized: ^\s*[A-Za-z]+\d+:\s*.

Applies to