Bibliothèque de classes .NET Framework
CompilerParameters, classe

Représente les paramètres utilisés pour appeler un compilateur.

Espace de noms : System.CodeDom.Compiler
Assembly : System (dans system.dll)

Syntaxe

Visual Basic (Déclaration)
<SerializableAttribute> _
Public Class CompilerParameters
Visual Basic (Utilisation)
Dim instance As CompilerParameters
C#
[SerializableAttribute] 
public class CompilerParameters
C++
[SerializableAttribute] 
public ref class CompilerParameters
J#
/** @attribute SerializableAttribute() */ 
public class CompilerParameters
JScript
SerializableAttribute 
public class CompilerParameters
Notes

Un objet CompilerParameters représente les paramètres et les options d'une interface ICodeCompiler.

Si vous compilez un programme exécutable, vous devez affecter la valeur true à la propriété GenerateExecutable. Lorsque la valeur de GenerateExecutable est false, le compilateur génère une bibliothèque de classes. Par défaut, un nouveau CompilerParameters est initialisé et la valeur de sa propriété GenerateExecutable est false. Si vous compilez un exécutable à partir d'un graphique CodeDOM, un CodeEntryPointMethod doit être défini dans le graphe. S'il existe plusieurs points d'entrée de code, vous devez spécifier la classe qui définit le point d'entrée à utiliser en affectant le nom de cette classe à la propriété MainClass.

Vous pouvez spécifier le nom de fichier de l'assembly de sortie dans la propriété OutputAssembly. Sinon, un nom de fichier de sortie par défaut est utilisé. Pour inclure des informations de débogage dans l'assembly généré, attribuez la valeur true à la propriété IncludeDebugInformation. Si votre projet référence des assemblys, vous devez spécifier leurs noms en tant qu'éléments d'un ensemble StringCollection de la propriété ReferencedAssemblies du CompilerParameters utilisé lorsque la compilation est appelée.

Vous pouvez compiler un assembly écrit en mémoire plutôt que sur disque en affectant la valeur true à la propriété GenerateInMemory. Lorsqu'un assembly est généré en mémoire, votre code peut obtenir une référence à l'assembly généré à partir de la propriété CompiledAssembly de CompilerResults. Si l'assembly est écrit sur disque, vous pouvez obtenir le chemin d'accès de l'assembly généré à partir de la propriété PathToAssembly de CompilerResults.

Pour spécifier le niveau d'avertissement auquel la compilation doit être interrompue, assignez à la propriété WarningLevel un entier correspondant au niveau d'avertissement auquel la compilation s'arrête. Il est également possible de configurer le compilateur de manière à ce qu'il interrompe la compilation en cas d'avertissements, en affectant à la propriété TreatWarningsAsErrors la valeur true.

Pour spécifier une chaîne d'arguments de ligne de commande personnalisés à utiliser lors de l'appel du processus de compilation, affectez cette chaîne à la propriété CompilerOptions. Si l'appel du processus de compilation requiert un jeton de sécurité Win32, spécifiez le jeton dans la propriété UserToken. Pour inclure des fichiers de ressources .NET Framework dans l'assembly compilé, ajoutez les noms des fichiers de ressources à la propriété EmbeddedResources. Pour référencer des ressources .NET Framework dans un autre assembly, ajoutez les noms des fichiers de ressources à la propriété LinkedResources. Pour inclure un fichier de ressources Win32 dans l'assembly compilé, spécifiez le nom de ce fichier dans la propriété Win32Resource.

RemarqueRemarque

Cette classe contient une demande de liaison et une demande d'héritage au niveau de la classe qui s'applique à tous les membres. Une exception SecurityException est levée lorsque l'appelant immédiat ou la classe dérivée ne dispose pas d'une autorisation avec un niveau de confiance total. Pour plus d'informations sur les demandes de sécurité, consultez Demandes de liaison et Demandes d'héritage.

Exemple

L'exemple suivant illustre l'utilisation de CompilerParameters pour spécifier plusieurs paramètres et options du compilateur.

Visual Basic
Public Shared Function CompileCode(provider As CodeDomProvider, _
    sourceFile As String, exeFile As String) As Boolean
   
    Dim cp As 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) Then
        ' Specify the class that contains 
        ' the main method of the executable.
        cp.MainClass = "Samples.Class1"
    End If
      
    If provider.Supports(GeneratorSupport.Resources) Then
        ' Set the embedded resource file of the assembly.
        ' This is useful for culture-neutral resources, 
        ' or default (fallback) resources.
        cp.EmbeddedResources.Add("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("nb-no.resources")
    End If
      
    ' Invoke compilation.
    Dim cr As CompilerResults = _
        provider.CompileAssemblyFromFile(cp, sourceFile)
      
    If cr.Errors.Count > 0 Then
        ' Display compilation errors.
        Console.WriteLine("Errors building {0} into {1}", _
            sourceFile, cr.PathToAssembly)
        Dim ce As CompilerError
        For Each ce In  cr.Errors
            Console.WriteLine("  {0}", ce.ToString())
            Console.WriteLine()
        Next ce
    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())
    End If
      
    ' Return the results of compilation.
    If cr.Errors.Count > 0 Then
        Return False
    Else
        Return True
    End If
End Function 'CompileCode
   
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 (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("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("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;
    }
}
C++
static bool CompileCode( CodeDomProvider^ provider,
   String^ sourceFile,
   String^ exeFile )
{

   CompilerParameters^ cp = gcnew CompilerParameters;
   if ( !cp)  
   {
      return false;
   }

   // 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 = gcnew TempFileCollection( ".",true );

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

   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( "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( "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 );
      for each ( CompilerError^ ce in cr->Errors )
      {
         Console::WriteLine( "  {0}", ce->ToString() );
         Console::WriteLine();
      }
   }
   else
   {
      Console::WriteLine( "Source {0} built into {1} successfully.",
         sourceFile, cr->PathToAssembly );
   }

   // Return the results of compilation.
   if ( cr->Errors->Count > 0 )
   {
      return false;
   }
   else
   {
      return true;
   }
}
Sécurité .NET Framework

Hiérarchie d'héritage

System.Object
  System.CodeDom.Compiler.CompilerParameters
Sécurité des threads

Les membres statiques publics (Shared en Visual Basic) de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Plates-formes

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0
Voir aussi

Mots clés :


Page view tracker