CompilerParameters Constructors

Definition

Namespace:

System.CodeDom.Compiler

Assembly:

System.CodeDom.dll

Initializes a new instance of the CompilerParameters class.

Overloads

CompilerParameters()	Initializes a new instance of the CompilerParameters class.
CompilerParameters(String[])	Initializes a new instance of the CompilerParameters class using the specified assembly names.
CompilerParameters(String[], String)	Initializes a new instance of the CompilerParameters class using the specified assembly names and output file name.
CompilerParameters(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.

CompilerParameters()

Source:

CompilerParameters.cs

Initializes a new instance of the CompilerParameters class.

C#

public CompilerParameters();

Examples

The following example illustrates using CompilerParameters to specify various compiler settings and options. This code example is part of a larger example provided for the CompilerParameters class.

C#

public static bool CompileCode(CodeDomProvider provider,
    String sourceFile,
    String exeFile)
{

    CompilerParameters cp = new CompilerParameters();

    // Generate an executable instead of
    // a class library.
    cp.GenerateExecutable = true;

    // Set the assembly file name to generate.
    cp.OutputAssembly = exeFile;

    // Generate debug information.
    cp.IncludeDebugInformation = true;

    // Add an assembly reference.
    cp.ReferencedAssemblies.Add( "System.dll" );

    // Save the assembly as a physical file.
    cp.GenerateInMemory = false;

    // Set the level at which the compiler
    // should start displaying warnings.
    cp.WarningLevel = 3;

    // Set whether to treat all warnings as errors.
    cp.TreatWarningsAsErrors = false;

    // Set compiler argument to optimize output.
    cp.CompilerOptions = "/optimize";

    // Set a temporary files collection.
    // The TempFileCollection stores the temporary files
    // generated during a build in the current directory,
    // and does not delete them after compilation.
    cp.TempFiles = new TempFileCollection(".", true);

    if (provider.Supports(GeneratorSupport.EntryPointMethod))
    {
        // Specify the class that contains
        // the main method of the executable.
        cp.MainClass = "Samples.Class1";
    }

    if (Directory.Exists("Resources"))
    {
        if (provider.Supports(GeneratorSupport.Resources))
        {
            // Set the embedded resource file of the assembly.
            // This is useful for culture-neutral resources,
            // or default (fallback) resources.
            cp.EmbeddedResources.Add("Resources\\Default.resources");

            // Set the linked resource reference files of the assembly.
            // These resources are included in separate assembly files,
            // typically localized for a specific language and culture.
            cp.LinkedResources.Add("Resources\\nb-no.resources");
        }
    }

    // Invoke compilation.
    CompilerResults cr = provider.CompileAssemblyFromFile(cp, sourceFile);

    if(cr.Errors.Count > 0)
    {
        // Display compilation errors.
        Console.WriteLine("Errors building {0} into {1}",
            sourceFile, cr.PathToAssembly);
        foreach(CompilerError ce in cr.Errors)
        {
            Console.WriteLine("  {0}", ce.ToString());
            Console.WriteLine();
        }
    }
    else
    {
        Console.WriteLine("Source {0} built into {1} successfully.",
            sourceFile, cr.PathToAssembly);
        Console.WriteLine("{0} temporary files created during the compilation.",
            cp.TempFiles.Count.ToString());
    }

    // Return the results of compilation.
    if (cr.Errors.Count > 0)
    {
        return false;
    }
    else
    {
        return true;
    }
}

CompilerParameters(String[])

Source:

CompilerParameters.cs

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

C#

public CompilerParameters(string[] assemblyNames);

Parameters

assemblyNames

String[]

The names of the assemblies to reference.

CompilerParameters(String[], String)

Source:

CompilerParameters.cs

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

C#

public CompilerParameters(string[] assemblyNames, string outputName);

Parameters

assemblyNames

String[]

The names of the assemblies to reference.

outputName

String

The output file name.

CompilerParameters(String[], String, Boolean)

Source:

CompilerParameters.cs

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

C#

public CompilerParameters(string[] assemblyNames, string outputName, bool includeDebugInformation);

Parameters

assemblyNames

String[]

The names of the assemblies to reference.

outputName

String

The output file name.

includeDebugInformation

Boolean

true to include debug information; false to exclude debug information.