Class CSharpCompilationOptions

Inheritance
object
CompilationOptions
CSharpCompilationOptions
Implements
Inherited Members
Namespace: Microsoft.CodeAnalysis.CSharp
Assembly: Microsoft.CodeAnalysis.CSharp.dll
Syntax
public sealed class CSharpCompilationOptions : CompilationOptions, IEquatable<CSharpCompilationOptions>

Constructors

CSharpCompilationOptions(OutputKind, bool, string?, string?, string?, IEnumerable<string>?, OptimizationLevel, bool, bool, string?, string?, ImmutableArray<byte>, bool?, Platform, ReportDiagnostic, int, IEnumerable<KeyValuePair<string, ReportDiagnostic>>?, bool, bool, XmlReferenceResolver?, SourceReferenceResolver?, MetadataReferenceResolver?, AssemblyIdentityComparer?, StrongNameProvider?, bool, MetadataImportOptions)

Declaration
public CSharpCompilationOptions(OutputKind outputKind, bool reportSuppressedDiagnostics, string? moduleName, string? mainTypeName, string? scriptClassName, IEnumerable<string>? usings, OptimizationLevel optimizationLevel, bool checkOverflow, bool allowUnsafe, string? cryptoKeyContainer, string? cryptoKeyFile, ImmutableArray<byte> cryptoPublicKey, bool? delaySign, Platform platform, ReportDiagnostic generalDiagnosticOption, int warningLevel, IEnumerable<KeyValuePair<string, ReportDiagnostic>>? specificDiagnosticOptions, bool concurrentBuild, bool deterministic, XmlReferenceResolver? xmlReferenceResolver, SourceReferenceResolver? sourceReferenceResolver, MetadataReferenceResolver? metadataReferenceResolver, AssemblyIdentityComparer? assemblyIdentityComparer, StrongNameProvider? strongNameProvider, bool publicSign, MetadataImportOptions metadataImportOptions)
Parameters
Type Name Description
OutputKind outputKind
bool reportSuppressedDiagnostics
string moduleName
string mainTypeName
string scriptClassName
IEnumerable<string> usings
OptimizationLevel optimizationLevel
bool checkOverflow
bool allowUnsafe
string cryptoKeyContainer
string cryptoKeyFile
ImmutableArray<byte> cryptoPublicKey
bool? delaySign
Platform platform
ReportDiagnostic generalDiagnosticOption
int warningLevel
IEnumerable<KeyValuePair<string, ReportDiagnostic>> specificDiagnosticOptions
bool concurrentBuild
bool deterministic
XmlReferenceResolver xmlReferenceResolver
SourceReferenceResolver sourceReferenceResolver
MetadataReferenceResolver metadataReferenceResolver
AssemblyIdentityComparer assemblyIdentityComparer
StrongNameProvider strongNameProvider
bool publicSign
MetadataImportOptions metadataImportOptions

CSharpCompilationOptions(OutputKind, bool, string?, string?, string?, IEnumerable<string>?, OptimizationLevel, bool, bool, string?, string?, ImmutableArray<byte>, bool?, Platform, ReportDiagnostic, int, IEnumerable<KeyValuePair<string, ReportDiagnostic>>?, bool, bool, XmlReferenceResolver?, SourceReferenceResolver?, MetadataReferenceResolver?, AssemblyIdentityComparer?, StrongNameProvider?, bool, MetadataImportOptions, NullableContextOptions)

Declaration
public CSharpCompilationOptions(OutputKind outputKind, bool reportSuppressedDiagnostics = false, string? moduleName = null, string? mainTypeName = null, string? scriptClassName = null, IEnumerable<string>? usings = null, OptimizationLevel optimizationLevel = OptimizationLevel.Debug, bool checkOverflow = false, bool allowUnsafe = false, string? cryptoKeyContainer = null, string? cryptoKeyFile = null, ImmutableArray<byte> cryptoPublicKey = default, bool? delaySign = null, Platform platform = Platform.AnyCpu, ReportDiagnostic generalDiagnosticOption = ReportDiagnostic.Default, int warningLevel = 4, IEnumerable<KeyValuePair<string, ReportDiagnostic>>? specificDiagnosticOptions = null, bool concurrentBuild = true, bool deterministic = false, XmlReferenceResolver? xmlReferenceResolver = null, SourceReferenceResolver? sourceReferenceResolver = null, MetadataReferenceResolver? metadataReferenceResolver = null, AssemblyIdentityComparer? assemblyIdentityComparer = null, StrongNameProvider? strongNameProvider = null, bool publicSign = false, MetadataImportOptions metadataImportOptions = MetadataImportOptions.Public, NullableContextOptions nullableContextOptions = NullableContextOptions.Disable)
Parameters
Type Name Description
OutputKind outputKind
bool reportSuppressedDiagnostics
string moduleName
string mainTypeName
string scriptClassName
IEnumerable<string> usings
OptimizationLevel optimizationLevel
bool checkOverflow
bool allowUnsafe
string cryptoKeyContainer
string cryptoKeyFile
ImmutableArray<byte> cryptoPublicKey
bool? delaySign
Platform platform
ReportDiagnostic generalDiagnosticOption
int warningLevel
IEnumerable<KeyValuePair<string, ReportDiagnostic>> specificDiagnosticOptions
bool concurrentBuild
bool deterministic
XmlReferenceResolver xmlReferenceResolver
SourceReferenceResolver sourceReferenceResolver
MetadataReferenceResolver metadataReferenceResolver
AssemblyIdentityComparer assemblyIdentityComparer
StrongNameProvider strongNameProvider
bool publicSign
MetadataImportOptions metadataImportOptions
NullableContextOptions nullableContextOptions

Properties

AllowUnsafe

Declaration
public bool AllowUnsafe { get; }
Property Value
Type Description
bool

Language

Declaration
public override string Language { get; }
Property Value
Type Description
string
Overrides

NullableContextOptions

Declaration
public override NullableContextOptions NullableContextOptions { get; protected set; }
Property Value
Type Description
NullableContextOptions
Overrides

Usings

Declaration
public ImmutableArray<string> Usings { get; }
Property Value
Type Description
ImmutableArray<string>

Methods

CommonWithAssemblyIdentityComparer(AssemblyIdentityComparer?)

Declaration
protected override CompilationOptions CommonWithAssemblyIdentityComparer(AssemblyIdentityComparer? comparer)
Parameters
Type Name Description
AssemblyIdentityComparer comparer
Returns
Type Description
CompilationOptions
Overrides

CommonWithCheckOverflow(bool)

Declaration
protected override CompilationOptions CommonWithCheckOverflow(bool checkOverflow)
Parameters
Type Name Description
bool checkOverflow
Returns
Type Description
CompilationOptions
Overrides

CommonWithConcurrentBuild(bool)

Declaration
protected override CompilationOptions CommonWithConcurrentBuild(bool concurrent)
Parameters
Type Name Description
bool concurrent
Returns
Type Description
CompilationOptions
Overrides

CommonWithCryptoKeyContainer(string?)

Declaration
protected override CompilationOptions CommonWithCryptoKeyContainer(string? cryptoKeyContainer)
Parameters
Type Name Description
string cryptoKeyContainer
Returns
Type Description
CompilationOptions
Overrides

CommonWithCryptoKeyFile(string?)

Declaration
protected override CompilationOptions CommonWithCryptoKeyFile(string? cryptoKeyFile)
Parameters
Type Name Description
string cryptoKeyFile
Returns
Type Description
CompilationOptions
Overrides

CommonWithCryptoPublicKey(ImmutableArray<byte>)

Declaration
protected override CompilationOptions CommonWithCryptoPublicKey(ImmutableArray<byte> cryptoPublicKey)
Parameters
Type Name Description
ImmutableArray<byte> cryptoPublicKey
Returns
Type Description
CompilationOptions
Overrides

CommonWithDelaySign(bool?)

Declaration
protected override CompilationOptions CommonWithDelaySign(bool? delaySign)
Parameters
Type Name Description
bool? delaySign
Returns
Type Description
CompilationOptions
Overrides

CommonWithDeterministic(bool)

Declaration
protected override CompilationOptions CommonWithDeterministic(bool deterministic)
Parameters
Type Name Description
bool deterministic
Returns
Type Description
CompilationOptions
Overrides

CommonWithFeatures(ImmutableArray<string>)

Declaration
[Obsolete]
protected override CompilationOptions CommonWithFeatures(ImmutableArray<string> features)
Parameters
Type Name Description
ImmutableArray<string> features
Returns
Type Description
CompilationOptions
Overrides

CommonWithGeneralDiagnosticOption(ReportDiagnostic)

Declaration
protected override CompilationOptions CommonWithGeneralDiagnosticOption(ReportDiagnostic value)
Parameters
Type Name Description
ReportDiagnostic value
Returns
Type Description
CompilationOptions
Overrides

CommonWithMainTypeName(string?)

Declaration
protected override CompilationOptions CommonWithMainTypeName(string? mainTypeName)
Parameters
Type Name Description
string mainTypeName
Returns
Type Description
CompilationOptions
Overrides

CommonWithMetadataImportOptions(MetadataImportOptions)

Declaration
protected override CompilationOptions CommonWithMetadataImportOptions(MetadataImportOptions value)
Parameters
Type Name Description
MetadataImportOptions value
Returns
Type Description
CompilationOptions
Overrides

CommonWithMetadataReferenceResolver(MetadataReferenceResolver?)

Declaration
protected override CompilationOptions CommonWithMetadataReferenceResolver(MetadataReferenceResolver? resolver)
Parameters
Type Name Description
MetadataReferenceResolver resolver
Returns
Type Description
CompilationOptions
Overrides

CommonWithModuleName(string?)

Declaration
protected override CompilationOptions CommonWithModuleName(string? moduleName)
Parameters
Type Name Description
string moduleName
Returns
Type Description
CompilationOptions
Overrides

CommonWithOptimizationLevel(OptimizationLevel)

Declaration
protected override CompilationOptions CommonWithOptimizationLevel(OptimizationLevel value)
Parameters
Type Name Description
OptimizationLevel value
Returns
Type Description
CompilationOptions
Overrides

CommonWithOutputKind(OutputKind)

Declaration
protected override CompilationOptions CommonWithOutputKind(OutputKind kind)
Parameters
Type Name Description
OutputKind kind
Returns
Type Description
CompilationOptions
Overrides

CommonWithPlatform(Platform)

Declaration
protected override CompilationOptions CommonWithPlatform(Platform platform)
Parameters
Type Name Description
Platform platform
Returns
Type Description
CompilationOptions
Overrides

CommonWithPublicSign(bool)

Declaration
protected override CompilationOptions CommonWithPublicSign(bool publicSign)
Parameters
Type Name Description
bool publicSign
Returns
Type Description
CompilationOptions
Overrides

CommonWithReportSuppressedDiagnostics(bool)

Declaration
protected override CompilationOptions CommonWithReportSuppressedDiagnostics(bool reportSuppressedDiagnostics)
Parameters
Type Name Description
bool reportSuppressedDiagnostics
Returns
Type Description
CompilationOptions
Overrides

CommonWithScriptClassName(string?)

Declaration
protected override CompilationOptions CommonWithScriptClassName(string? scriptClassName)
Parameters
Type Name Description
string scriptClassName
Returns
Type Description
CompilationOptions
Overrides

CommonWithSourceReferenceResolver(SourceReferenceResolver?)

Declaration
protected override CompilationOptions CommonWithSourceReferenceResolver(SourceReferenceResolver? resolver)
Parameters
Type Name Description
SourceReferenceResolver resolver
Returns
Type Description
CompilationOptions
Overrides

CommonWithSpecificDiagnosticOptions(IEnumerable<KeyValuePair<string, ReportDiagnostic>>?)

Declaration
protected override CompilationOptions CommonWithSpecificDiagnosticOptions(IEnumerable<KeyValuePair<string, ReportDiagnostic>>? specificDiagnosticOptions)
Parameters
Type Name Description
IEnumerable<KeyValuePair<string, ReportDiagnostic>> specificDiagnosticOptions
Returns
Type Description
CompilationOptions
Overrides

CommonWithSpecificDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>?)

Declaration
protected override CompilationOptions CommonWithSpecificDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>? specificDiagnosticOptions)
Parameters
Type Name Description
ImmutableDictionary<string, ReportDiagnostic> specificDiagnosticOptions
Returns
Type Description
CompilationOptions
Overrides

CommonWithStrongNameProvider(StrongNameProvider?)

Declaration
protected override CompilationOptions CommonWithStrongNameProvider(StrongNameProvider? provider)
Parameters
Type Name Description
StrongNameProvider provider
Returns
Type Description
CompilationOptions
Overrides

CommonWithSyntaxTreeOptionsProvider(SyntaxTreeOptionsProvider?)

Declaration
protected override CompilationOptions CommonWithSyntaxTreeOptionsProvider(SyntaxTreeOptionsProvider? provider)
Parameters
Type Name Description
SyntaxTreeOptionsProvider provider
Returns
Type Description
CompilationOptions
Overrides

CommonWithXmlReferenceResolver(XmlReferenceResolver?)

Declaration
protected override CompilationOptions CommonWithXmlReferenceResolver(XmlReferenceResolver? resolver)
Parameters
Type Name Description
XmlReferenceResolver resolver
Returns
Type Description
CompilationOptions
Overrides

ComputeHashCode()

Declaration
protected override int ComputeHashCode()
Returns
Type Description
int
Overrides

Equals(CSharpCompilationOptions?)

Declaration
public bool Equals(CSharpCompilationOptions? other)
Parameters
Type Name Description
CSharpCompilationOptions 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

WithAllowUnsafe(bool)

Declaration
public CSharpCompilationOptions WithAllowUnsafe(bool enabled)
Parameters
Type Name Description
bool enabled
Returns
Type Description
CSharpCompilationOptions

WithAssemblyIdentityComparer(AssemblyIdentityComparer?)

Declaration
public CSharpCompilationOptions WithAssemblyIdentityComparer(AssemblyIdentityComparer? comparer)
Parameters
Type Name Description
AssemblyIdentityComparer comparer
Returns
Type Description
CSharpCompilationOptions

WithConcurrentBuild(bool)

Declaration
public CSharpCompilationOptions WithConcurrentBuild(bool concurrentBuild)
Parameters
Type Name Description
bool concurrentBuild
Returns
Type Description
CSharpCompilationOptions

WithCryptoKeyContainer(string?)

Declaration
public CSharpCompilationOptions WithCryptoKeyContainer(string? name)
Parameters
Type Name Description
string name
Returns
Type Description
CSharpCompilationOptions

WithCryptoKeyFile(string?)

Declaration
public CSharpCompilationOptions WithCryptoKeyFile(string? path)
Parameters
Type Name Description
string path
Returns
Type Description
CSharpCompilationOptions

WithCryptoPublicKey(ImmutableArray<byte>)

Declaration
public CSharpCompilationOptions WithCryptoPublicKey(ImmutableArray<byte> value)
Parameters
Type Name Description
ImmutableArray<byte> value
Returns
Type Description
CSharpCompilationOptions

WithDelaySign(bool?)

Declaration
public CSharpCompilationOptions WithDelaySign(bool? value)
Parameters
Type Name Description
bool? value
Returns
Type Description
CSharpCompilationOptions

WithDeterministic(bool)

Declaration
public CSharpCompilationOptions WithDeterministic(bool deterministic)
Parameters
Type Name Description
bool deterministic
Returns
Type Description
CSharpCompilationOptions

WithGeneralDiagnosticOption(ReportDiagnostic)

Declaration
public CSharpCompilationOptions WithGeneralDiagnosticOption(ReportDiagnostic value)
Parameters
Type Name Description
ReportDiagnostic value
Returns
Type Description
CSharpCompilationOptions

WithMainTypeName(string?)

Declaration
public CSharpCompilationOptions WithMainTypeName(string? name)
Parameters
Type Name Description
string name
Returns
Type Description
CSharpCompilationOptions

WithMetadataImportOptions(MetadataImportOptions)

Declaration
public CSharpCompilationOptions WithMetadataImportOptions(MetadataImportOptions value)
Parameters
Type Name Description
MetadataImportOptions value
Returns
Type Description
CSharpCompilationOptions

WithMetadataReferenceResolver(MetadataReferenceResolver?)

Declaration
public CSharpCompilationOptions WithMetadataReferenceResolver(MetadataReferenceResolver? resolver)
Parameters
Type Name Description
MetadataReferenceResolver resolver
Returns
Type Description
CSharpCompilationOptions

WithModuleName(string?)

Declaration
public CSharpCompilationOptions WithModuleName(string? moduleName)
Parameters
Type Name Description
string moduleName
Returns
Type Description
CSharpCompilationOptions

WithNullableContextOptions(NullableContextOptions)

Declaration
public CSharpCompilationOptions WithNullableContextOptions(NullableContextOptions options)
Parameters
Type Name Description
NullableContextOptions options
Returns
Type Description
CSharpCompilationOptions

WithOptimizationLevel(OptimizationLevel)

Declaration
public CSharpCompilationOptions WithOptimizationLevel(OptimizationLevel value)
Parameters
Type Name Description
OptimizationLevel value
Returns
Type Description
CSharpCompilationOptions

WithOutputKind(OutputKind)

Declaration
public CSharpCompilationOptions WithOutputKind(OutputKind kind)
Parameters
Type Name Description
OutputKind kind
Returns
Type Description
CSharpCompilationOptions

WithOverflowChecks(bool)

Declaration
public CSharpCompilationOptions WithOverflowChecks(bool enabled)
Parameters
Type Name Description
bool enabled
Returns
Type Description
CSharpCompilationOptions

WithPlatform(Platform)

Declaration
public CSharpCompilationOptions WithPlatform(Platform platform)
Parameters
Type Name Description
Platform platform
Returns
Type Description
CSharpCompilationOptions

WithPublicSign(bool)

Declaration
public CSharpCompilationOptions WithPublicSign(bool publicSign)
Parameters
Type Name Description
bool publicSign
Returns
Type Description
CSharpCompilationOptions

WithReportSuppressedDiagnostics(bool)

Declaration
public CSharpCompilationOptions WithReportSuppressedDiagnostics(bool reportSuppressedDiagnostics)
Parameters
Type Name Description
bool reportSuppressedDiagnostics
Returns
Type Description
CSharpCompilationOptions

WithScriptClassName(string?)

Declaration
public CSharpCompilationOptions WithScriptClassName(string? name)
Parameters
Type Name Description
string name
Returns
Type Description
CSharpCompilationOptions

WithSourceReferenceResolver(SourceReferenceResolver?)

Declaration
public CSharpCompilationOptions WithSourceReferenceResolver(SourceReferenceResolver? resolver)
Parameters
Type Name Description
SourceReferenceResolver resolver
Returns
Type Description
CSharpCompilationOptions

WithSpecificDiagnosticOptions(IEnumerable<KeyValuePair<string, ReportDiagnostic>>?)

Declaration
public CSharpCompilationOptions WithSpecificDiagnosticOptions(IEnumerable<KeyValuePair<string, ReportDiagnostic>>? values)
Parameters
Type Name Description
IEnumerable<KeyValuePair<string, ReportDiagnostic>> values
Returns
Type Description
CSharpCompilationOptions

WithSpecificDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>?)

Declaration
public CSharpCompilationOptions WithSpecificDiagnosticOptions(ImmutableDictionary<string, ReportDiagnostic>? values)
Parameters
Type Name Description
ImmutableDictionary<string, ReportDiagnostic> values
Returns
Type Description
CSharpCompilationOptions

WithStrongNameProvider(StrongNameProvider?)

Declaration
public CSharpCompilationOptions WithStrongNameProvider(StrongNameProvider? provider)
Parameters
Type Name Description
StrongNameProvider provider
Returns
Type Description
CSharpCompilationOptions

WithSyntaxTreeOptionsProvider(SyntaxTreeOptionsProvider?)

Declaration
public CSharpCompilationOptions WithSyntaxTreeOptionsProvider(SyntaxTreeOptionsProvider? provider)
Parameters
Type Name Description
SyntaxTreeOptionsProvider provider
Returns
Type Description
CSharpCompilationOptions

WithUsings(IEnumerable<string>?)

Declaration
public CSharpCompilationOptions WithUsings(IEnumerable<string>? usings)
Parameters
Type Name Description
IEnumerable<string> usings
Returns
Type Description
CSharpCompilationOptions

WithUsings(ImmutableArray<string>)

Declaration
public CSharpCompilationOptions WithUsings(ImmutableArray<string> usings)
Parameters
Type Name Description
ImmutableArray<string> usings
Returns
Type Description
CSharpCompilationOptions

WithUsings(params string[]?)

Declaration
public CSharpCompilationOptions WithUsings(params string[]? usings)
Parameters
Type Name Description
string[] usings
Returns
Type Description
CSharpCompilationOptions

WithWarningLevel(int)

Declaration
public CSharpCompilationOptions WithWarningLevel(int warningLevel)
Parameters
Type Name Description
int warningLevel
Returns
Type Description
CSharpCompilationOptions

WithXmlReferenceResolver(XmlReferenceResolver?)

Declaration
public CSharpCompilationOptions WithXmlReferenceResolver(XmlReferenceResolver? resolver)
Parameters
Type Name Description
XmlReferenceResolver resolver
Returns
Type Description
CSharpCompilationOptions

Implements