Class EmitOptions

Inheritance

object

EmitOptions

Implements

IEquatable<EmitOptions>

Inherited Members

object.GetType()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Microsoft.CodeAnalysis.Emit

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public sealed class EmitOptions : IEquatable<EmitOptions>

Constructors

EmitOptions(bool, DebugInformationFormat, string, string, int, ulong, bool, SubsystemVersion, string, bool, bool)

Declaration

public EmitOptions(bool metadataOnly, DebugInformationFormat debugInformationFormat, string pdbFilePath, string outputNameOverride, int fileAlignment, ulong baseAddress, bool highEntropyVirtualAddressSpace, SubsystemVersion subsystemVersion, string runtimeMetadataVersion, bool tolerateErrors, bool includePrivateMembers)

Parameters

Type	Name	Description
bool	metadataOnly
DebugInformationFormat	debugInformationFormat
string	pdbFilePath
string	outputNameOverride
int	fileAlignment
ulong	baseAddress
bool	highEntropyVirtualAddressSpace
SubsystemVersion	subsystemVersion
string	runtimeMetadataVersion
bool	tolerateErrors
bool	includePrivateMembers

EmitOptions(bool, DebugInformationFormat, string, string, int, ulong, bool, SubsystemVersion, string, bool, bool, ImmutableArray<InstrumentationKind>)

Declaration

public EmitOptions(bool metadataOnly, DebugInformationFormat debugInformationFormat, string pdbFilePath, string outputNameOverride, int fileAlignment, ulong baseAddress, bool highEntropyVirtualAddressSpace, SubsystemVersion subsystemVersion, string runtimeMetadataVersion, bool tolerateErrors, bool includePrivateMembers, ImmutableArray<InstrumentationKind> instrumentationKinds)

Parameters

Type	Name	Description
bool	metadataOnly
DebugInformationFormat	debugInformationFormat
string	pdbFilePath
string	outputNameOverride
int	fileAlignment
ulong	baseAddress
bool	highEntropyVirtualAddressSpace
SubsystemVersion	subsystemVersion
string	runtimeMetadataVersion
bool	tolerateErrors
bool	includePrivateMembers
ImmutableArray<InstrumentationKind>	instrumentationKinds

EmitOptions(bool, DebugInformationFormat, string?, string?, int, ulong, bool, SubsystemVersion, string?, bool, bool, ImmutableArray<InstrumentationKind>, HashAlgorithmName?)

Declaration

public EmitOptions(bool metadataOnly, DebugInformationFormat debugInformationFormat, string? pdbFilePath, string? outputNameOverride, int fileAlignment, ulong baseAddress, bool highEntropyVirtualAddressSpace, SubsystemVersion subsystemVersion, string? runtimeMetadataVersion, bool tolerateErrors, bool includePrivateMembers, ImmutableArray<InstrumentationKind> instrumentationKinds, HashAlgorithmName? pdbChecksumAlgorithm)

Parameters

Type	Name	Description
bool	metadataOnly
DebugInformationFormat	debugInformationFormat
string	pdbFilePath
string	outputNameOverride
int	fileAlignment
ulong	baseAddress
bool	highEntropyVirtualAddressSpace
SubsystemVersion	subsystemVersion
string	runtimeMetadataVersion
bool	tolerateErrors
bool	includePrivateMembers
ImmutableArray<InstrumentationKind>	instrumentationKinds
HashAlgorithmName?	pdbChecksumAlgorithm

EmitOptions(bool, DebugInformationFormat, string?, string?, int, ulong, bool, SubsystemVersion, string?, bool, bool, ImmutableArray<InstrumentationKind>, HashAlgorithmName?, Encoding?, Encoding?)

Declaration

public EmitOptions(bool metadataOnly = false, DebugInformationFormat debugInformationFormat = (DebugInformationFormat)0, string? pdbFilePath = null, string? outputNameOverride = null, int fileAlignment = 0, ulong baseAddress = 0, bool highEntropyVirtualAddressSpace = false, SubsystemVersion subsystemVersion = default, string? runtimeMetadataVersion = null, bool tolerateErrors = false, bool includePrivateMembers = true, ImmutableArray<InstrumentationKind> instrumentationKinds = default, HashAlgorithmName? pdbChecksumAlgorithm = null, Encoding? defaultSourceFileEncoding = null, Encoding? fallbackSourceFileEncoding = null)

Parameters

Type	Name	Description
bool	metadataOnly
DebugInformationFormat	debugInformationFormat
string	pdbFilePath
string	outputNameOverride
int	fileAlignment
ulong	baseAddress
bool	highEntropyVirtualAddressSpace
SubsystemVersion	subsystemVersion
string	runtimeMetadataVersion
bool	tolerateErrors
bool	includePrivateMembers
ImmutableArray<InstrumentationKind>	instrumentationKinds
HashAlgorithmName?	pdbChecksumAlgorithm
Encoding	defaultSourceFileEncoding
Encoding	fallbackSourceFileEncoding

Properties

BaseAddress

Declaration

public ulong BaseAddress { get; }

Property Value

Type	Description
ulong

DebugInformationFormat

Declaration

public DebugInformationFormat DebugInformationFormat { get; }

Property Value

Type	Description
DebugInformationFormat

DefaultSourceFileEncoding

Declaration

public Encoding? DefaultSourceFileEncoding { get; }

Property Value

Type	Description
Encoding

EmitMetadataOnly

Declaration

public bool EmitMetadataOnly { get; }

Property Value

Type	Description
bool

FallbackSourceFileEncoding

Declaration

public Encoding? FallbackSourceFileEncoding { get; }

Property Value

Type	Description
Encoding

FileAlignment

Declaration

public int FileAlignment { get; }

Property Value

Type	Description
int

HighEntropyVirtualAddressSpace

Declaration

public bool HighEntropyVirtualAddressSpace { get; }

Property Value

Type	Description
bool

IncludePrivateMembers

Declaration

public bool IncludePrivateMembers { get; }

Property Value

Type	Description
bool

InstrumentationKinds

Declaration

public ImmutableArray<InstrumentationKind> InstrumentationKinds { get; }

Property Value

Type	Description
ImmutableArray<InstrumentationKind>

OutputNameOverride

Declaration

public string? OutputNameOverride { get; }

Property Value

Type	Description
string

PdbChecksumAlgorithm

Declaration

public HashAlgorithmName PdbChecksumAlgorithm { get; }

Property Value

Type	Description
HashAlgorithmName

PdbFilePath

Declaration

public string? PdbFilePath { get; }

Property Value

Type	Description
string

RuntimeMetadataVersion

Declaration

public string? RuntimeMetadataVersion { get; }

Property Value

Type	Description
string

SubsystemVersion

Declaration

public SubsystemVersion SubsystemVersion { get; }

Property Value

Type	Description
SubsystemVersion

TolerateErrors

Declaration

public bool TolerateErrors { get; }

Property Value

Type	Description
bool

Methods

Equals(EmitOptions?)

Declaration

public bool Equals(EmitOptions? other)

Parameters

Type	Name	Description
EmitOptions	other

Returns

Type	Description
bool

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

WithBaseAddress(ulong)

Declaration

public EmitOptions WithBaseAddress(ulong value)

Parameters

Type	Name	Description
ulong	value

Returns

Type	Description
EmitOptions

WithDebugInformationFormat(DebugInformationFormat)

Declaration

public EmitOptions WithDebugInformationFormat(DebugInformationFormat format)

Parameters

Type	Name	Description
DebugInformationFormat	format

Returns

Type	Description
EmitOptions

WithDefaultSourceFileEncoding(Encoding?)

Declaration

public EmitOptions WithDefaultSourceFileEncoding(Encoding? defaultSourceFileEncoding)

Parameters

Type	Name	Description
Encoding	defaultSourceFileEncoding

Returns

Type	Description
EmitOptions

WithEmitMetadataOnly(bool)

Declaration

public EmitOptions WithEmitMetadataOnly(bool value)

Parameters

Type	Name	Description
bool	value

Returns

Type	Description
EmitOptions

WithFallbackSourceFileEncoding(Encoding?)

Declaration

public EmitOptions WithFallbackSourceFileEncoding(Encoding? fallbackSourceFileEncoding)

Parameters

Type	Name	Description
Encoding	fallbackSourceFileEncoding

Returns

Type	Description
EmitOptions

WithFileAlignment(int)

Declaration

public EmitOptions WithFileAlignment(int value)

Parameters

Type	Name	Description
int	value

Returns

Type	Description
EmitOptions

WithHighEntropyVirtualAddressSpace(bool)

Declaration

public EmitOptions WithHighEntropyVirtualAddressSpace(bool value)

Parameters

Type	Name	Description
bool	value

Returns

Type	Description
EmitOptions

WithIncludePrivateMembers(bool)

Declaration

public EmitOptions WithIncludePrivateMembers(bool value)

Parameters

Type	Name	Description
bool	value

Returns

Type	Description
EmitOptions

WithInstrumentationKinds(ImmutableArray<InstrumentationKind>)

Declaration

public EmitOptions WithInstrumentationKinds(ImmutableArray<InstrumentationKind> instrumentationKinds)

Parameters

Type	Name	Description
ImmutableArray<InstrumentationKind>	instrumentationKinds

Returns

Type	Description
EmitOptions

WithOutputNameOverride(string)

Declaration

public EmitOptions WithOutputNameOverride(string outputName)

Parameters

Type	Name	Description
string	outputName

Returns

Type	Description
EmitOptions

WithPdbChecksumAlgorithm(HashAlgorithmName)

Declaration

public EmitOptions WithPdbChecksumAlgorithm(HashAlgorithmName name)

Parameters

Type	Name	Description
HashAlgorithmName	name

Returns

Type	Description
EmitOptions

WithPdbFilePath(string)

Declaration

public EmitOptions WithPdbFilePath(string path)

Parameters

Type	Name	Description
string	path

Returns

Type	Description
EmitOptions

WithRuntimeMetadataVersion(string)

Declaration

public EmitOptions WithRuntimeMetadataVersion(string version)

Parameters

Type	Name	Description
string	version

Returns

Type	Description
EmitOptions

WithSubsystemVersion(SubsystemVersion)

Declaration

public EmitOptions WithSubsystemVersion(SubsystemVersion subsystemVersion)

Parameters

Type	Name	Description
SubsystemVersion	subsystemVersion

Returns

Type	Description
EmitOptions

WithTolerateErrors(bool)

Declaration

public EmitOptions WithTolerateErrors(bool value)

Parameters

Type	Name	Description
bool	value

Returns

Type	Description
EmitOptions

Operators

operator ==(EmitOptions?, EmitOptions?)

Declaration

public static bool operator ==(EmitOptions? left, EmitOptions? right)

Parameters

Type	Name	Description
EmitOptions	left
EmitOptions	right

Returns

Type	Description
bool

operator !=(EmitOptions?, EmitOptions?)

Declaration

public static bool operator !=(EmitOptions? left, EmitOptions? right)

Parameters

Type	Name	Description
EmitOptions	left
EmitOptions	right

Returns

Type	Description
bool

Implements

IEquatable<T>