CompilerParameters Class

 

Represents the parameters used to invoke a compiler.

Namespace:   System.CodeDom.Compiler
Assembly:  System (in System.dll)


[<SerializableAttribute>]
[<PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")>]
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
type CompilerParameters = class end

NameDescription
System_CAPS_pubmethodCompilerParameters()

Initializes a new instance of the CompilerParameters class.

System_CAPS_pubmethodCompilerParameters(String[])

Initializes a new instance of the CompilerParameters class using the specified assembly names.

System_CAPS_pubmethodCompilerParameters(String[], String)

Initializes a new instance of the CompilerParameters class using the specified assembly names and output file name.

System_CAPS_pubmethodCompilerParameters(String[], String, Boolean)

Initializes a new instance of the CompilerParameters class using the specified assembly names, output name, and a value indicating whether to include debug information.

NameDescription
System_CAPS_pubpropertyCompilerOptions

Gets or sets optional command-line arguments to use when invoking the compiler.

System_CAPS_pubpropertyCoreAssemblyFileName

Gets or sets the name of the core or standard assembly that contains basic types such as Object, String, or Int32.

System_CAPS_pubpropertyEmbeddedResources

Gets the .NET Framework resource files to include when compiling the assembly output.

System_CAPS_pubpropertyEvidence

Obsolete. Specifies an evidence object that represents the security policy permissions to grant the compiled assembly.

System_CAPS_pubpropertyGenerateExecutable

Gets or sets a value indicating whether to generate an executable.

System_CAPS_pubpropertyGenerateInMemory

Gets or sets a value indicating whether to generate the output in memory.

System_CAPS_pubpropertyIncludeDebugInformation

Gets or sets a value indicating whether to include debug information in the compiled executable.

System_CAPS_pubpropertyLinkedResources

Gets the .NET Framework resource files that are referenced in the current source.

System_CAPS_pubpropertyMainClass

Gets or sets the name of the main class.

System_CAPS_pubpropertyOutputAssembly

Gets or sets the name of the output assembly.

System_CAPS_pubpropertyReferencedAssemblies

Gets the assemblies referenced by the current project.

System_CAPS_pubpropertyTempFiles

Gets or sets the collection that contains the temporary files.

System_CAPS_pubpropertyTreatWarningsAsErrors

Gets or sets a value indicating whether to treat warnings as errors.

System_CAPS_pubpropertyUserToken

Gets or sets the user token to use when creating the compiler process.

System_CAPS_pubpropertyWarningLevel

Gets or sets the warning level at which the compiler aborts compilation.

System_CAPS_pubpropertyWin32Resource

Gets or sets the file name of a Win32 resource file to link into the compiled assembly.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

A CompilerParameters object represents the settings and options for an ICodeCompiler interface.

If you are compiling an executable program, you must set the GenerateExecutable property to true. When the GenerateExecutable is set to false, the compiler will generate a class library. By default, a new CompilerParameters is initialized with its GenerateExecutable property set to false. If you are compiling an executable from a CodeDOM graph, a CodeEntryPointMethod must be defined in the graph. If there are multiple code entry points, you can indicate the class that defines the entry point to use by setting the name of the class to the MainClass property.

You can specify a file name for the output assembly in the OutputAssembly property. Otherwise, a default output file name will be used. To include debug information in a generated assembly, set the IncludeDebugInformation property to true. If your project references any assemblies, you must specify the assembly names as items in a StringCollection set to the ReferencedAssemblies property of the CompilerParameters used when invoking compilation.

You can compile an assembly that is written to memory rather than disk by setting the GenerateInMemory property to true. When an assembly is generated in memory, your code can obtain a reference to the generated assembly from the CompiledAssembly property of a CompilerResults. If an assembly is written to disk, you can obtain the path to the generated assembly from the PathToAssembly property of a CompilerResults.

To specify a warning level at which to halt compilation, set the WarningLevel property to an integer that represents the warning level at which to halt compilation. You can also configure the compiler to halt compilation if warnings are encountered by setting the TreatWarningsAsErrors property to true.

To specify a custom command-line arguments string to use when invoking the compilation process, set the string in the CompilerOptions property. If a Win32 security token is required to invoke the compiler process, specify the token in the UserToken property. To include .NET Framework resource files in the compiled assembly, add the names of the resource files to the EmbeddedResources property. To reference .NET Framework resources in another assembly, add the names of the resource files to the LinkedResources property. To include a Win32 resource file in the compiled assembly, specify the name of the Win32 resource file in the Win32Resource property.

System_CAPS_noteNote

This class contains a link demand and an inheritance demand at the class level that applies to all members. A SecurityException is thrown when either the immediate caller or the derived class does not have full-trust permission. For details about security demands, see Link Demands and Inheritance Demands.

The following example builds a CodeDOM source graph for a simple Hello World program. The source is then saved to a file, compiled into an executable, and run. The CompileCode method illustrates how to use the CompilerParameters class to specify various compiler settings and options.

No code example is currently available or this language may not be supported.

SecurityAction.LinkDemand

for full trust for the immediate caller. This class cannot be used by partially trusted code.

SecurityAction.InheritanceDemand

for full trust for inheritors. This class cannot be inherited by partially trusted code.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: