BinaryLogReplayEventSource.OpenBuildEventsReader Method

Definition

Namespace:

Microsoft.Build.Logging

Assembly:

Microsoft.Build.dll

Package:

Microsoft.Build v17.11.4

Overloads

OpenBuildEventsReader(BinaryReader, Boolean, Boolean)	Creates a BuildEventArgsReader for the provided binary reader over binary log file. Caller is responsible for disposing the returned reader.
OpenBuildEventsReader(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.

OpenBuildEventsReader(BinaryReader, Boolean, Boolean)

Source:

BinaryLogReplayEventSource.cs

Creates a BuildEventArgsReader for the provided binary reader over binary log file. Caller is responsible for disposing the returned reader.

public static Microsoft.Build.Logging.BuildEventArgsReader OpenBuildEventsReader (System.IO.BinaryReader binaryReader, bool closeInput, bool allowForwardCompatibility = false);

static member OpenBuildEventsReader : System.IO.BinaryReader * bool * bool -> Microsoft.Build.Logging.BuildEventArgsReader

Public Shared Function OpenBuildEventsReader (binaryReader As BinaryReader, closeInput As Boolean, Optional allowForwardCompatibility As Boolean = false) As BuildEventArgsReader

Parameters

binaryReader

BinaryReader

closeInput

Boolean

Indicates whether the passed BinaryReader should be closed on disposing.

allowForwardCompatibility

Boolean

Unknown build events or unknown parts of known build events will be ignored if this is set to true.

Returns

BuildEventArgsReader

BuildEventArgsReader over the given binlog file binary reader.

OpenBuildEventsReader(String)

Source:

BinaryLogReplayEventSource.cs

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.

public:
 static Microsoft::Build::Logging::BuildEventArgsReader ^ OpenBuildEventsReader(System::String ^ sourceFilePath);

public static Microsoft.Build.Logging.BuildEventArgsReader OpenBuildEventsReader (string sourceFilePath);

static member OpenBuildEventsReader : string -> Microsoft.Build.Logging.BuildEventArgsReader

Public Shared Function OpenBuildEventsReader (sourceFilePath As String) As BuildEventArgsReader

Parameters

sourceFilePath

String

Returns

BuildEventArgsReader

BinaryReader of the given binlog file.