VisualBasicCommandLineArguments Class

Definition

The CommandLineArguments class provides members to Set and Get Visual Basic compilation and parse options.

public ref class VisualBasicCommandLineArguments sealed : Microsoft::CodeAnalysis::CommandLineArguments
public sealed class VisualBasicCommandLineArguments : Microsoft.CodeAnalysis.CommandLineArguments
type VisualBasicCommandLineArguments = class
    inherit CommandLineArguments
Public NotInheritable Class VisualBasicCommandLineArguments
Inherits CommandLineArguments
Inheritance
VisualBasicCommandLineArguments

Properties

AdditionalFiles

A set of additional non-code text files that can be used by analyzers.

(Inherited from CommandLineArguments)
AnalyzerConfigPaths

A set of paths to EditorConfig-compatible analyzer config files.

(Inherited from CommandLineArguments)
AnalyzerReferences

References to analyzers supplied on the command line.

(Inherited from CommandLineArguments)
AppConfigPath

An absolute path of the app.config file or null if not specified.

(Inherited from CommandLineArguments)
BaseDirectory

Directory used to resolve relative paths stored in the arguments.

(Inherited from CommandLineArguments)
ChecksumAlgorithm

Hash algorithm to use to calculate source file debug checksums and PDB checksum.

(Inherited from CommandLineArguments)
CompilationName

Compilation name or null if not specified.

(Inherited from CommandLineArguments)
CompilationOptions

Set and Get the Visual Basic compilation options.

CompilationOptionsCore (Inherited from CommandLineArguments)
DisplayHelp

If true, append the command line help during Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)

(Inherited from CommandLineArguments)
DisplayLangVersions

If true, prepend the compiler-supported language versions during Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)

(Inherited from CommandLineArguments)
DisplayLogo

If true, prepend the command line header logo during Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken).

(Inherited from CommandLineArguments)
DisplayVersion

If true, append the compiler version during Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)

(Inherited from CommandLineArguments)
DocumentationPath

Absolute path of the documentation comment XML file or null if not specified.

(Inherited from CommandLineArguments)
EmbeddedFiles

A set of files to embed in the PDB.

(Inherited from CommandLineArguments)
EmitOptions

Gets the emit options.

(Inherited from CommandLineArguments)
EmitPdb

True to emit PDB information (to a standalone PDB file or embedded into the PE file).

(Inherited from CommandLineArguments)
EmitPdbFile

Returns true if the PDB is generated to a PDB file, as opposed to embedded to the output binary and not generated at all.

(Inherited from CommandLineArguments)
Encoding

Encoding to be used for source files or 'null' for autodetect/default.

(Inherited from CommandLineArguments)
ErrorLogOptions

Options controlling the generation of a SARIF log file containing compilation or analysis diagnostics, or null if no log file is desired.

(Inherited from CommandLineArguments)
ErrorLogPath

Options controlling the generation of a SARIF log file containing compilation or analysis diagnostics, or null if no log file is desired.

(Inherited from CommandLineArguments)
Errors

Errors while parsing the command line arguments.

(Inherited from CommandLineArguments)
GeneratedFilesOutputDirectory

Absolute path of the directory to place generated files in, or null to not emit any generated files.

(Inherited from CommandLineArguments)
InteractiveMode

Drop to an interactive loop. If a script is specified in SourceFiles executes the script first.

(Inherited from CommandLineArguments)
KeyFileSearchPaths

Sequence of absolute paths used to search for key files.

(Inherited from CommandLineArguments)
ManifestResources

Resources specified as arguments to the compilation.

(Inherited from CommandLineArguments)
MetadataReferences

References to metadata supplied on the command line. Includes assemblies specified via /r and netmodules specified via /addmodule.

(Inherited from CommandLineArguments)
NoWin32Manifest

If true, do not embed any Win32 manifest, including one specified by Win32Manifest or any default manifest.

(Inherited from CommandLineArguments)
OutputDirectory

Absolute path of the output directory (could only be null if there is an error reported).

(Inherited from CommandLineArguments)
OutputFileName

Name of the output file or null if not specified.

(Inherited from CommandLineArguments)
OutputRefFilePath

Path of the output ref assembly or null if not specified.

(Inherited from CommandLineArguments)
ParseOptions

Set and Get the Visual Basic parse options.

ParseOptionsCore (Inherited from CommandLineArguments)
PathMap

A list of pairs of paths. This stores the value of the command-line compiler option /pathMap:X1=Y1;X2=Y2... which causes a prefix of X1 followed by a path separator to be replaced by Y1 followed by a path separator, and so on for each following pair.

(Inherited from CommandLineArguments)
PdbPath

Path of the PDB file or null if same as output binary path with .pdb extension.

(Inherited from CommandLineArguments)
PreferredUILang

Specify the preferred output language name.

(Inherited from CommandLineArguments)
PrintFullPaths

If true, prints the full path of the file containing errors or warnings in diagnostics.

(Inherited from CommandLineArguments)
ReferencePaths

Sequence of absolute paths used to search for references.

(Inherited from CommandLineArguments)
ReportAnalyzer (Inherited from CommandLineArguments)
ReportInternalsVisibleToAttributes

Report additional information related to InternalsVisibleToAttributes for all assemblies the compiler sees in this compilation.

(Inherited from CommandLineArguments)
RuleSetPath

Absolute path of the .ruleset file or null if not specified.

(Inherited from CommandLineArguments)
ScriptArguments

Arguments following a script file or separator "--". Null if the command line parser is not interactive.

(Inherited from CommandLineArguments)
SkipAnalyzers (Inherited from CommandLineArguments)
SourceFiles

Source file paths.

(Inherited from CommandLineArguments)
SourceLink

Path of the file containing information linking the compilation to source server that stores a snapshot of the source code included in the compilation.

(Inherited from CommandLineArguments)
SourcePaths

Sequence of absolute paths used to search for sources specified as #load directives.

(Inherited from CommandLineArguments)
TouchedFilesPath

Full path of a log of file paths accessed by the compiler, or null if file logging should be suppressed.

(Inherited from CommandLineArguments)
Utf8Output

If true, use UTF-8 for output.

(Inherited from CommandLineArguments)
Win32Icon

The path to a .ico icon file.

(Inherited from CommandLineArguments)
Win32Manifest

The path to a Win32 manifest file to embed into the output portable executable (PE) file.

(Inherited from CommandLineArguments)
Win32ResourceFile

The path to a Win32 resource.

(Inherited from CommandLineArguments)

Methods

GetOutputFilePath(String)

Returns a full path of the file that the compiler will generate the assembly to if compilation succeeds.

(Inherited from CommandLineArguments)
GetPdbFilePath(String)

Returns a full path of the PDB file that the compiler will generate the debug symbols to if EmitPdbFile is true and the compilation succeeds.

(Inherited from CommandLineArguments)
ResolveAnalyzerReferences(IAnalyzerAssemblyLoader)

Resolves analyzer references stored in AnalyzerReferences using given file resolver.

(Inherited from CommandLineArguments)
ResolveMetadataReferences(MetadataReferenceResolver)

Resolves metadata references stored in MetadataReferences using given file resolver and metadata provider.

(Inherited from CommandLineArguments)

Applies to