ModuleMetadata.CreateFromStream Method

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.9.2

Overloads

CreateFromStream(Stream, PEStreamOptions)	Create metadata module from a stream.
CreateFromStream(Stream, Boolean)	Create metadata module from a stream.

CreateFromStream(Stream, PEStreamOptions)

Source:

ModuleMetadata.cs

Create metadata module from a stream.

public:
 static Microsoft::CodeAnalysis::ModuleMetadata ^ CreateFromStream(System::IO::Stream ^ peStream, System::Reflection::PortableExecutable::PEStreamOptions options);

public static Microsoft.CodeAnalysis.ModuleMetadata CreateFromStream (System.IO.Stream peStream, System.Reflection.PortableExecutable.PEStreamOptions options);

static member CreateFromStream : System.IO.Stream * System.Reflection.PortableExecutable.PEStreamOptions -> Microsoft.CodeAnalysis.ModuleMetadata

Public Shared Function CreateFromStream (peStream As Stream, options As PEStreamOptions) As ModuleMetadata

Parameters

peStream

Stream

Stream containing portable executable image. Position zero should contain the first byte of the DOS header ("MZ").

options

PEStreamOptions

Options specifying how sections of the PE image are read from the stream. Unless LeaveOpen is specified, the responsibility for disposal of the stream is transferred upon entry of the constructor unless the arguments given are invalid.

Returns

ModuleMetadata

Exceptions

ArgumentNullException

peStream is null.

ArgumentException

The stream doesn't support read and seek operations.

ArgumentOutOfRangeException

options has an invalid value.

BadImageFormatException

PrefetchMetadata or PrefetchEntireImage is specified and the PE headers of the image are invalid.

IOException

PrefetchMetadata or PrefetchEntireImage is specified and an error occurs while reading the stream.

CreateFromStream(Stream, Boolean)

Source:

ModuleMetadata.cs

Create metadata module from a stream.

public static Microsoft.CodeAnalysis.ModuleMetadata CreateFromStream (System.IO.Stream peStream, bool leaveOpen = false);

static member CreateFromStream : System.IO.Stream * bool -> Microsoft.CodeAnalysis.ModuleMetadata

Public Shared Function CreateFromStream (peStream As Stream, Optional leaveOpen As Boolean = false) As ModuleMetadata

Parameters

peStream

Stream

Stream containing portable executable image. Position zero should contain the first byte of the DOS header ("MZ").

leaveOpen

Boolean

False to close the stream upon disposal of the metadata (the responsibility for disposal of the stream is transferred upon entry of the constructor unless the arguments given are invalid).

Returns

ModuleMetadata

Exceptions

ArgumentNullException

peStream is null.

ArgumentException

The stream doesn't support seek operations.