MSBuildServerLifecycleEventArgs Class

Definition

Namespace:: Microsoft.Build.Framework

Assembly:: Microsoft.Build.Framework.dll

Package:: Microsoft.Build.Framework v18.10.1

Source:: MSBuildServerLifecycleEventArgs.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.

Records how a build related to the MSBuild Server node (spawned, reused, or requested but not used). This is a dedicated, versionable event type rather than an ad-hoc message so that tooling can recognize and render it structurally. It is written to the binary log under its own record kind; forward-compatible binary-log readers that predate the record kind skip it via the length-prefixed record framing.

public ref class MSBuildServerLifecycleEventArgs sealed : Microsoft::Build::Framework::BuildMessageEventArgs

public sealed class MSBuildServerLifecycleEventArgs : Microsoft.Build.Framework.BuildMessageEventArgs

type MSBuildServerLifecycleEventArgs = class
    inherit BuildMessageEventArgs

Public NotInheritable Class MSBuildServerLifecycleEventArgs
Inherits BuildMessageEventArgs

Inheritance: EventArgs

BuildEventArgs

LazyFormattedBuildEventArgs

BuildMessageEventArgs
MSBuildServerLifecycleEventArgs

Constructors

Name	Description
MSBuildServerLifecycleEventArgs(MSBuildServerLifecycleKind, Int32, String, String, String, MessageImportance, Boolean)	Initializes a new instance of the MSBuildServerLifecycleEventArgs class.

Properties

Name	Description
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)
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)
Kind	How the build related to the MSBuild Server node.
LineNumber	Line number of interest in associated file. (Inherited from BuildMessageEventArgs)
Message	Gets the formatted message. (Inherited from LazyFormattedBuildEventArgs)
ProcessId	The MSBuild Server node's process id, or 0 when not applicable.
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 timestamp field to derived types. Used for serialization. Avoids the side effects of calling the Timestamp getter. (Inherited from BuildEventArgs)
Reason	A localized, human-readable reason the server was not used (for NotUsed); otherwise `null`.
ReasonCode	A stable, non-localized code identifying the fall-back cause (for NotUsed); otherwise `null`.
SenderName	Name of the object sending this event. (Inherited from BuildEventArgs)
ShortLived	`true` when a spawned server node will tear itself down after this build instead of staying resident for reuse (a "short-lived" server — a `/mt` build with node reuse off).
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