BuildFinishedEventArgs Class

Reference

Definition

Namespace:: Microsoft.Build.Framework

Assembly:: Microsoft.Build.Framework.dll

Package:: Microsoft.Build.Framework v15.9.20

Package:: Microsoft.Build.Framework v16.11.0

Package:: Microsoft.Build.Framework v17.11.4

Source:: BuildFinishedEventArgs.cs

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.

This class represents the event arguments for build finished events.

public ref class BuildFinishedEventArgs : Microsoft::Build::Framework::BuildStatusEventArgs

[System.Serializable]
public class BuildFinishedEventArgs : Microsoft.Build.Framework.BuildStatusEventArgs

[<System.Serializable>]
type BuildFinishedEventArgs = class
    inherit BuildStatusEventArgs

Public Class BuildFinishedEventArgs
Inherits BuildStatusEventArgs

Inheritance: EventArgs

BuildEventArgs

LazyFormattedBuildEventArgs

BuildStatusEventArgs
BuildFinishedEventArgs

Inheritance: EventArgs

BuildEventArgs

BuildStatusEventArgs
BuildFinishedEventArgs

Attributes: SerializableAttribute

Remarks

WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility

Constructors

BuildFinishedEventArgs()	Default constructor
BuildFinishedEventArgs(String, String, Boolean, DateTime, Object[])	Constructor which allows the timestamp to be set
BuildFinishedEventArgs(String, String, Boolean, DateTime)	Constructor which allows the timestamp to be set
BuildFinishedEventArgs(String, String, Boolean)	Constructor to initialize all parameters. Sender field cannot be set here and is assumed to be "MSBuild"

Fields

locker

Lock object.

(Inherited from LazyFormattedBuildEventArgs)

Properties

BuildEventContext	Event contextual information for the build event argument (Inherited from BuildEventArgs)
HelpKeyword	Custom help keyword associated with event. (Inherited from BuildEventArgs)
Message	Gets the formatted message. (Inherited from LazyFormattedBuildEventArgs)
Message	Text of event. (Inherited from BuildEventArgs)
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)
Succeeded	Succeeded is true if the build succeeded; false otherwise.
ThreadId	The thread that raised event. (Inherited from BuildEventArgs)
Timestamp	The time when event was raised. (Inherited from BuildEventArgs)

Applies to

Share via