Aracılığıyla paylaş


ExtendedCustomBuildEventArgs Class

Definition

Generic custom event. Extended data are implemented by IExtendedBuildEventArgs

public ref class ExtendedCustomBuildEventArgs sealed : Microsoft::Build::Framework::CustomBuildEventArgs, Microsoft::Build::Framework::IExtendedBuildEventArgs
public sealed class ExtendedCustomBuildEventArgs : Microsoft.Build.Framework.CustomBuildEventArgs, Microsoft.Build.Framework.IExtendedBuildEventArgs
type ExtendedCustomBuildEventArgs = class
    inherit CustomBuildEventArgs
    interface IExtendedBuildEventArgs
Public NotInheritable Class ExtendedCustomBuildEventArgs
Inherits CustomBuildEventArgs
Implements IExtendedBuildEventArgs
Inheritance
Implements

Constructors

ExtendedCustomBuildEventArgs(String, String, String, String, DateTime, Object[])

This constructor allows event data to be initialized including timestamp.

ExtendedCustomBuildEventArgs(String, String, String, String, DateTime)

This constructor allows event data to be initialized including timestamp.

ExtendedCustomBuildEventArgs(String, String, String, String)

This constructor allows event data to be initialized.

ExtendedCustomBuildEventArgs(String)

This constructor allows event data to be initialized.

Fields

locker

Lock object.

(Inherited from LazyFormattedBuildEventArgs)

Properties

BuildEventContext

Event contextual information for the build event argument

(Inherited from BuildEventArgs)
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.

HelpKeyword

Custom help keyword associated with event.

(Inherited from BuildEventArgs)
Message

Gets the formatted message.

(Inherited from LazyFormattedBuildEventArgs)
RawMessage

Exposes the underlying message field without side-effects. Used for serialization.

(Inherited from BuildEventArgs)
RawTimestamp

Exposes the private 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)
ThreadId

The thread that raised event.

(Inherited from BuildEventArgs)
Timestamp

The time when event was raised.

(Inherited from BuildEventArgs)

Applies to