IVsProjectBuildMessageEvents.OnBuildMessage Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Called for every build message received from the build system by the implementer of IVsProjectBuildMessageReporter. This method is called before the implementer does any usual processing of the message (such as creating a corresponding Error List item, and so on).

bool OnBuildMessage(unsigned int Category, std::wstring const & szMessage, std::wstring const & szErrorCode, std::wstring const & szHelpKeyword, int line, int column, int endingLine, int endingColumn, std::wstring const & szFile, winrt::Windows::Foundation::IInspectable const & pAdditionalInfo);

public bool OnBuildMessage (uint Category, string szMessage, string szErrorCode, string szHelpKeyword, int line, int column, int endingLine, int endingColumn, string szFile, object pAdditionalInfo);

abstract member OnBuildMessage : uint32 * string * string * string * int * int * int * int * string * obj -> bool

Public Function OnBuildMessage (Category As UInteger, szMessage As String, szErrorCode As String, szHelpKeyword As String, line As Integer, column As Integer, endingLine As Integer, endingColumn As Integer, szFile As String, Optional pAdditionalInfo As Object) As Boolean

Parameters

Category

UInt32

[in] Describes the severity of the error message.

szMessage

String

[in] The error message.

szErrorCode

String

[in] The error code of the error message.

szHelpKeyword

String

[in] Keyword for the error message.

line

Int32

[in] Starting line on which the error occurred. Line numbers start at 1.

column

Int32

[in] Starting column in which the error occurred. Column numbers start at 1.

endingLine

Int32

[in] Ending line on which the error occurred.

endingColumn

Int32

[in] Ending column in which the error occurred.

szFile

String

[in] The file in which the error occurred.

pAdditionalInfo

Object

[in, optional] Object containing any additional information about the error message.

Returns

Boolean

Boolean that indicates if any more error messages should be processed. If true, the caller must assume that the implementation of this method has taken full responsibility over its proper processing and reporting. In particular, the caller must not create any Error List items corresponding to this message. Furthermore, if there is more than one subscriber to this event, the remaining subscribers will not be called. If false, the caller must proceed to invoke any remaining subscribers. If all subscribers set this value to false, the message will be processed normally (that is, an Error List item is created and so on).