IVsProjectBuildMessageEvents.OnBuildMessage Method

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).

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)

Syntax

'Declaration
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, _
    pAdditionalInfo As Object _
) As Boolean
bool OnBuildMessage(
    uint Category,
    string szMessage,
    string szErrorCode,
    string szHelpKeyword,
    int line,
    int column,
    int endingLine,
    int endingColumn,
    string szFile,
    Object pAdditionalInfo
)
bool OnBuildMessage(
    [InAttribute] unsigned int Category, 
    [InAttribute] String^ szMessage, 
    [InAttribute] String^ szErrorCode, 
    [InAttribute] String^ szHelpKeyword, 
    [InAttribute] int line, 
    [InAttribute] int column, 
    [InAttribute] int endingLine, 
    [InAttribute] int endingColumn, 
    [InAttribute] String^ szFile, 
    [InAttribute] Object^ pAdditionalInfo
)
abstract OnBuildMessage : 
        Category:uint32 * 
        szMessage:string * 
        szErrorCode:string * 
        szHelpKeyword:string * 
        line:int * 
        column:int * 
        endingLine:int * 
        endingColumn:int * 
        szFile:string * 
        pAdditionalInfo:Object -> bool
function OnBuildMessage(
    Category : uint, 
    szMessage : String, 
    szErrorCode : String, 
    szHelpKeyword : String, 
    line : int, 
    column : int, 
    endingLine : int, 
    endingColumn : int, 
    szFile : String, 
    pAdditionalInfo : Object
) : boolean

Parameters

  • Category
    Type: UInt32

    [in] Describes the severity of the error message.

  • szMessage
    Type: String

    [in] The error message.

  • szErrorCode
    Type: String

    [in] The error code of the error message.

  • szHelpKeyword
    Type: String

    [in] Keyword for the error message.

  • line
    Type: Int32

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

  • column
    Type: Int32

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

  • endingLine
    Type: Int32

    [in] Ending line on which the error occurred.

  • endingColumn
    Type: Int32

    [in] Ending column in which the error occurred.

  • szFile
    Type: String

    [in] The file in which the error occurred.

  • pAdditionalInfo
    Type: Object

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

Return Value

Type: 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).

.NET Framework Security

See Also

Reference

IVsProjectBuildMessageEvents Interface

Microsoft.VisualStudio.Shell.Interop Namespace