IExtendedBuildEventArgs Interface

  • Reference

Definition

Namespace:
Microsoft.Build.Framework
Assembly:
Microsoft.Build.Framework.dll
Package:
Microsoft.Build.Framework v17.9.5

Interface for Extended EventArgs to allow enriching particular events with extended data. Deriving from EventArgs will be deprecated soon and using Extended EventArgs is recommended for custom Event Args.

public interface class IExtendedBuildEventArgs
public interface IExtendedBuildEventArgs
type IExtendedBuildEventArgs = interface
Public Interface IExtendedBuildEventArgs
Derived

Properties

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.

Applies to