ExtendedBuildErrorEventArgs 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 error events including extended data for event enriching. Extended data are implemented by IExtendedBuildEventArgs

public ref class ExtendedBuildErrorEventArgs sealed : Microsoft::Build::Framework::BuildErrorEventArgs, Microsoft::Build::Framework::IExtendedBuildEventArgs

public sealed class ExtendedBuildErrorEventArgs : Microsoft.Build.Framework.BuildErrorEventArgs, Microsoft.Build.Framework.IExtendedBuildEventArgs

type ExtendedBuildErrorEventArgs = class
    inherit BuildErrorEventArgs
    interface IExtendedBuildEventArgs

Public NotInheritable Class ExtendedBuildErrorEventArgs
Inherits BuildErrorEventArgs
Implements IExtendedBuildEventArgs

Inheritance: EventArgs

BuildEventArgs

LazyFormattedBuildEventArgs

BuildErrorEventArgs
ExtendedBuildErrorEventArgs

Implements: IExtendedBuildEventArgs

Constructors

ExtendedBuildErrorEventArgs(String)	This constructor specifies only type of extended data.
ExtendedBuildErrorEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String)	This constructor allows all event data to be initialized
ExtendedBuildErrorEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, DateTime)	This constructor which allows a timestamp to be set
ExtendedBuildErrorEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, DateTime, Object[])	This constructor which allows a timestamp to be set
ExtendedBuildErrorEventArgs(String, String, String, String, Int32, Int32, Int32, Int32, String, String, String, String, DateTime, Object[])	This constructor which 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 BuildErrorEventArgs)
ColumnNumber	Column number of interest in associated file. (Inherited from BuildErrorEventArgs)
EndColumnNumber	Ending column number of interest in associated file. (Inherited from BuildErrorEventArgs)
EndLineNumber	Ending line number of interest in associated file. (Inherited from BuildErrorEventArgs)
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 BuildErrorEventArgs)
HelpKeyword	Custom help keyword associated with event. (Inherited from BuildEventArgs)
HelpLink	A link pointing to more information about the error. (Inherited from BuildErrorEventArgs)
LineNumber	Line number of interest in associated file. (Inherited from BuildErrorEventArgs)
Message	Gets the formatted message. (Inherited from LazyFormattedBuildEventArgs)
ProjectFile	The project file which issued this event. (Inherited from BuildErrorEventArgs)
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 BuildErrorEventArgs)
ThreadId	The thread that raised event. (Inherited from BuildEventArgs)
Timestamp	The time when event was raised. (Inherited from BuildEventArgs)

Applies to