BinaryLogReplayEventSource Class

Reference

Definition

Namespace:: Microsoft.Build.Logging

Assembly:: Microsoft.Build.dll

Package:: Microsoft.Build v15.9.20

Package:: Microsoft.Build v16.11.0

Package:: Microsoft.Build 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.

Provides a method to read a binary log file (*.binlog) and replay all stored BuildEventArgs by implementing IEventSource and raising corresponding events.

public ref class BinaryLogReplayEventSource sealed : Microsoft::Build::Logging::EventArgsDispatcher

public sealed class BinaryLogReplayEventSource : Microsoft.Build.Logging.EventArgsDispatcher

type BinaryLogReplayEventSource = class
    inherit EventArgsDispatcher

Public NotInheritable Class BinaryLogReplayEventSource
Inherits EventArgsDispatcher

Inheritance: Object

EventArgsDispatcher
BinaryLogReplayEventSource

Remarks

The class is public so that we can call it from MSBuild.exe when replaying a log file.

Constructors

BinaryLogReplayEventSource()

Methods

Dispatch(BuildEventArgs)	Raise one of the events that is appropriate for the type of the BuildEventArgs (Inherited from EventArgsDispatcher)
OpenReader(String)	Creates a BinaryReader for the provided binary log file. Performs decompression and buffering in the optimal way. Caller is responsible for disposing the returned reader.
Replay(BinaryReader, CancellationToken)	Read the provided binary log file and raise corresponding events for each BuildEventArgs
Replay(String)	Read the provided binary log file and raise corresponding events for each BuildEventArgs
Replay(String, CancellationToken)	Read the provided binary log file and raise corresponding events for each BuildEventArgs

Events

AnyEventRaised	This event is raised for all BuildEventArgs objects after a more type-specific event (Inherited from EventArgsDispatcher)
BuildFinished	Raised for BuildFinishedEventArgs instances (Inherited from EventArgsDispatcher)
BuildStarted	Raised for BuildStartedEventArgs instances (Inherited from EventArgsDispatcher)
CustomEventRaised	Raised for CustomBuildEventArgs instances (Inherited from EventArgsDispatcher)
ErrorRaised	Raised for BuildErrorEventArgs instances (Inherited from EventArgsDispatcher)
MessageRaised	Raised for BuildMessageEventArgs instances (Inherited from EventArgsDispatcher)
NotificationsSourceCreated	Raised once BuildEventArgsReader is created during replaying
ProjectFinished	Raised for ProjectFinishedEventArgs instances (Inherited from EventArgsDispatcher)
ProjectStarted	Raised for ProjectStartedEventArgs instances (Inherited from EventArgsDispatcher)
StatusEventRaised	Raised for BuildStatusEventArgs instances (Inherited from EventArgsDispatcher)
TargetFinished	Raised for TargetFinishedEventArgs instances (Inherited from EventArgsDispatcher)
TargetStarted	Raised for TargetStartedEventArgs instances (Inherited from EventArgsDispatcher)
TaskFinished	Raised for TaskFinishedEventArgs instances (Inherited from EventArgsDispatcher)
TaskStarted	Raised for TaskStartedEventArgs instances (Inherited from EventArgsDispatcher)
WarningRaised	Raised for BuildWarningEventArgs instances (Inherited from EventArgsDispatcher)

Applies to