ExtendedBuildMessageEventArgs Class

Reference

Definition

Namespace:: Microsoft.Build.Framework

Assembly:: Microsoft.Build.Framework.dll

Package:: Microsoft.Build.Framework 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.

Generic custom build events including extended data for event enriching. Extended data are implemented by IExtendedBuildEventArgs

public ref class ExtendedBuildMessageEventArgs sealed : Microsoft::Build::Framework::BuildMessageEventArgs, Microsoft::Build::Framework::IExtendedBuildEventArgs

public sealed class ExtendedBuildMessageEventArgs : Microsoft.Build.Framework.BuildMessageEventArgs, Microsoft.Build.Framework.IExtendedBuildEventArgs

type ExtendedBuildMessageEventArgs = class
    inherit BuildMessageEventArgs
    interface IExtendedBuildEventArgs

Public NotInheritable Class ExtendedBuildMessageEventArgs
Inherits BuildMessageEventArgs
Implements IExtendedBuildEventArgs

Inheritance: EventArgs

BuildEventArgs

LazyFormattedBuildEventArgs

BuildMessageEventArgs
ExtendedBuildMessageEventArgs

Implements: IExtendedBuildEventArgs

Constructors

ExtendedBuildMessageEventArgs(String)	This constructor specifies only type of extended data.
ExtendedBuildMessageEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, MessageImportance)	This constructor allows all event data to be initialized
ExtendedBuildMessageEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, MessageImportance, DateTime)	This constructor which allows a timestamp to be set
ExtendedBuildMessageEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, MessageImportance, DateTime, Object[])	This constructor which allows a timestamp to be set
ExtendedBuildMessageEventArgs(String, String, String, String, MessageImportance)	This constructor allows all event data to be initialized
ExtendedBuildMessageEventArgs(String, String, String, String, MessageImportance, DateTime)	This constructor allows a timestamp to be set
ExtendedBuildMessageEventArgs(String, String, String, String, MessageImportance, DateTime, Object[])	This constructor allows a timestamp to be set

Fields

locker

Lock object.

(Inherited from LazyFormattedBuildEventArgs)

Properties

BuildEventContext	Event contextual information for the build event argument (Inherited from BuildEventArgs)
Code	Code associated with event. (Inherited from BuildMessageEventArgs)
ColumnNumber	Column number of interest in associated file. (Inherited from BuildMessageEventArgs)
EndColumnNumber	Ending column number of interest in associated file. (Inherited from BuildMessageEventArgs)
EndLineNumber	Ending line number of interest in associated file. (Inherited from BuildMessageEventArgs)
ExtendedData	Transparent data as string. Custom code is responsible to serialize and deserialize this string to structured data - if needed. Custom code can use any serialization they deem safe - e.g. json for textual data, base64 for binary data...
ExtendedMetadata	Metadata of ExtendedData. Example usage: data which needed in custom code to properly routing this message without interpreting/deserializing ExtendedData. simple extended data can be transferred in form of dictionary key-value per one extended property.
ExtendedType	Unique string identifying type of extended data so receiver side knows how to interpret, deserialize and handle ExtendedData.
File	File associated with event. (Inherited from BuildMessageEventArgs)
HelpKeyword	Custom help keyword associated with event. (Inherited from BuildEventArgs)
Importance	Importance of the message (Inherited from BuildMessageEventArgs)
LineNumber	Line number of interest in associated file. (Inherited from BuildMessageEventArgs)
Message	Gets the formatted message. (Inherited from LazyFormattedBuildEventArgs)
ProjectFile	The project which was building when the message was issued. (Inherited from BuildMessageEventArgs)
RawMessage	Exposes the underlying message field without side-effects. Used for serialization. (Inherited from BuildEventArgs)
RawTimestamp	Exposes the private Microsoft.Build.Framework.BuildEventArgs.timestamp field to derived types. Used for serialization. Avoids the side effects of calling the Timestamp getter. (Inherited from BuildEventArgs)
SenderName	Name of the object sending this event. (Inherited from BuildEventArgs)
Subcategory	The custom sub-type of the event. (Inherited from BuildMessageEventArgs)
ThreadId	The thread that raised event. (Inherited from BuildEventArgs)
Timestamp	The time when event was raised. (Inherited from BuildEventArgs)

Applies to