TaskLoggingHelper.LogMessageFromText(String, MessageImportance) 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.

Logs an error/warning/message from the given line of text. Errors/warnings are only logged for lines that fit a particular (canonical) format -- all other lines are treated as messages. Thread safe.

public:
 bool LogMessageFromText(System::String ^ lineOfText, Microsoft::Build::Framework::MessageImportance messageImportance);

public bool LogMessageFromText (string lineOfText, Microsoft.Build.Framework.MessageImportance messageImportance);

member this.LogMessageFromText : string * Microsoft.Build.Framework.MessageImportance -> bool

Public Function LogMessageFromText (lineOfText As String, messageImportance As MessageImportance) As Boolean

Parameters

lineOfText: String

The line of text to log from.

messageImportance: MessageImportance

The importance level for messages that are neither errors nor warnings.

Returns

Boolean

true, if an error was logged

Exceptions

ArgumentNullException

Thrown when lineOfText is null.

Remarks

Errors messages and warnings are only logged for lines that fit the canonical format. All other lines are treated as messages.

Applies to