Engine Classe

Definizione

Avviso

Questa API è ora obsoleta.

Rappresenta il motore MSBuild.Represents the MSBuild engine.

public ref class Engine
[System.Obsolete("This class has been deprecated. Please use Microsoft.Build.Evaluation.ProjectCollection from the Microsoft.Build assembly instead.")]
public class Engine
type Engine = class
Public Class Engine
Ereditarietà
Engine
Attributi

Esempi

Nell'esempio seguente viene creato Engine un oggetto e viene BuildProjectFile utilizzato il metodo per compilare un file di progetto.The following example creates an Engine object and uses the BuildProjectFile method to build a project file. La FileLogger classe viene usata per registrare le informazioni in un file.The FileLogger class is used to log information to a file.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;

namespace BuildAProjectCS
{
    class Program
    {       
        static void Main(string[] args)
        {
            // Instantiate a new Engine object
            Engine engine = new Engine();

            // Point to the path that contains the .NET Framework 2.0 CLR and tools
            engine.BinPath = @"c:\windows\microsoft.net\framework\v2.0.xxxxx";
            

            // Instantiate a new FileLogger to generate build log
            FileLogger logger = new FileLogger();

            // Set the logfile parameter to indicate the log destination
            logger.Parameters = @"logfile=C:\temp\build.log";

            // Register the logger with the engine
            engine.RegisterLogger(logger);

            // Build a project file
            bool success = engine.BuildProjectFile(@"c:\temp\validate.proj");

            //Unregister all loggers to close the log file
            engine.UnregisterAllLoggers();

            if (success)
                Console.WriteLine("Build succeeded.");
            else
                Console.WriteLine(@"Build failed. View C:\temp\build.log for details");

        }
    }
}
Module Module1
    'Add references to Microsoft.Build.Framework and
    'Microsoft.Build.BuildEngine
    Sub Main()
        'Create a new Engine object
        Dim engine As New Engine()

        'Point to the path that contains the .NET Framework 2.0 CLR and tools
        engine.BinPath = "c:\windows\microsoft.net\framework\v2.0.xxxxx"

        'Instantiate a new FileLogger to generate a build log
        Dim logger As New FileLogger()

        'Set logfile parameter to indicate the log destination
        logger.Parameters = "logfile=c:\temp\build.log"

        'Register the logger with the engine
        engine.RegisterLogger(logger)

        'Build the project file
        Dim success As Boolean = engine.BuildProjectFile("c:\temp\validate.proj")

        'Unregister all loggers to close the log file
        engine.UnregisterAllLoggers()

        If success Then
            Console.WriteLine("Build succeeded.")
        Else
            Console.WriteLine("Build failed. View C:\temp\build.log for details.")
        End If
    End Sub

End Module

Commenti

In un sistema di dipendenze da progetto a progetto, Engine gestisce i progetti di compilazione, rendendo possibile la creazione della stessa destinazione nello stesso progetto più di una volta in una determinata compilazione.In a system of project-to-project dependencies, the Engine maintains the building projects, making it possible to avoid building the same target in the same project more than once in a given build.

Costruttori

Engine()

Inizializza una nuova istanza della classe Engine.Initializes a new instance of the Engine class.

Engine(BuildPropertyGroup)

Inizializza una nuova istanza della classe Engine.Initializes a new instance of the Engine class.

Engine(BuildPropertyGroup, ToolsetDefinitionLocations)

Inizializza una nuova istanza della classe Engine.Initializes a new instance of the Engine class.

Engine(BuildPropertyGroup, ToolsetDefinitionLocations, Int32, String)

Inizializza una nuova istanza della classe Engine.Initializes a new instance of the Engine class.

Engine(String)

Inizializza una nuova istanza della classe Engine con l'oggetto BinPath specificato.Initializes a new instance of the Engine class that has the specified BinPath.

Engine(ToolsetDefinitionLocations)

Inizializza una nuova istanza della classe Engine.Initializes a new instance of the Engine class.

Proprietà

BinPath

Ottiene o imposta il percorso del file MSBuild.exe.Gets or sets the path to MSBuild.exe.

BuildEnabled

Ottiene o imposta un valore che indica se la compilazione di destinazioni è attivata nel progetto.Gets or sets a value that indicates whether the building of targets in the project is enabled.

DefaultToolsVersion

Valore ToolsVersion predefinito di questo motore di compilazione.The default ToolsVersion of this build engine.

GlobalEngine

Ottiene la classe Engine che è globale (condivisa) per la classe AppDomain.Gets the Engine that is global (shared) for this AppDomain.

GlobalProperties

Ottiene o imposta una raccolta delle proprietà globali per il progetto.Gets or sets a collection of the global properties for the project.

IsBuilding

Indica se è attualmente in corso la compilazione di un progetto.Gets whether a project is currently being built.

OnlyLogCriticalEvents

Ottiene o imposta un valore che indica se, durante la compilazione, devono essere registrati solo gli eventi critici, ad esempio avvisi ed errori.Gets or sets a value that indicates whether to only log critical events, such as warnings and errors, during the build.

Toolsets

Imposta o restituisce la raccolta di set di strumenti riconosciuta da questa istanza del modulo di gestione della compilazione.Sets or Gets the collection of Toolsets that are recognized by this build engine instance.

Version

Ottiene la versione della classe Engine.Gets the version of the Engine.

Metodi

BuildProject(Project)

Compila la classe Project specificata.Builds the specified Project.

BuildProject(Project, String)

Compila la destinazione specificata della classe Project specificata.Builds the specified target of the specified Project.

BuildProject(Project, String[])

Compila le destinazioni specificate della classe Project specificata.Builds the specified targets of the specified Project.

BuildProject(Project, String[], IDictionary)

Compila le destinazioni specificate della classe Project specificata e restituisce gli output delle destinazioni.Builds the specified targets of the specified Project, and returns the outputs of the targets.

BuildProject(Project, String[], IDictionary, BuildSettings)

Compila le destinazioni specificate della classe Project specificata con l'enumerazione BuildSettings specificata e restituisce gli output delle destinazioni.Builds the specified targets of the specified Project with the specified BuildSettings, and returns the outputs of the targets.

BuildProjectFile(String)

Carica il file di progetto specificato e compila il progetto.Loads the specified project file and builds the project.

BuildProjectFile(String, String)

Carica il file di progetto specificato e compila la destinazione del progetto specificata.Loads the specified project file and builds the specified target of the project.

BuildProjectFile(String, String[])

Carica il file di progetto specificato e compila le destinazioni del progetto specificate.Loads the specified project file and builds the specified targets of the project.

BuildProjectFile(String, String[], BuildPropertyGroup)

Carica il file di progetto specificato e compila le destinazioni del progetto specificate con la proprietà GlobalProperties specificata, quindi restituisce gli output delle destinazioni.Loads the specified project file and builds the specified targets of the project with the specified GlobalProperties, and returns the outputs of the targets.

BuildProjectFile(String, String[], BuildPropertyGroup, IDictionary)

Carica il file di progetto specificato e compila le destinazioni del progetto specificate con la proprietà GlobalProperties specificata, quindi restituisce gli output delle destinazioni.Loads the specified project file and builds the specified targets of the project with the specified GlobalProperties, and returns the outputs of the targets.

BuildProjectFile(String, String[], BuildPropertyGroup, IDictionary, BuildSettings)

Carica il file di progetto specificato e compila le destinazioni del progetto specificate con l'enumerazione BuildSettings e la proprietà GlobalProperties specificate, quindi restituisce gli output delle destinazioni.Loads the specified project file and builds the specified targets of the project with the specified BuildSettings and GlobalProperties, and returns the outputs of the targets.

BuildProjectFile(String, String[], BuildPropertyGroup, IDictionary, BuildSettings, String)

Carica un file di progetto dal disco e compila le destinazioni specificate.Loads a project file from disk and builds the given targets.

BuildProjectFiles(String[], String[][], BuildPropertyGroup[], IDictionary[], BuildSettings, String[])

Carica un insieme di file di progetto dal disco, quindi compila l'elenco specificato di destinazioni per ogni progetto.Loads a set of project files from disk and then builds the given list of targets for each project.

CreateNewProject()

Crea un oggetto Project vuoto associato a questo oggetto Engine.Creates an empty Project object that is associated with this Engine.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Ereditato da Object)
GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Ereditato da Object)
GetLoadedProject(String)

Restituisce l'oggetto Project associato al file del progetto specificato.Returns the Project object that is associated with the specified project file.

GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Ereditato da Object)
RegisterDistributedLogger(ILogger, LoggerDescription)

Registra i logger distribuiti con il motore di compilazione.Registers distributed loggers with the build engine.

RegisterLogger(ILogger)

Registra il logger specificato con la classe Engine.Registers the specified logger with the Engine.

Shutdown()

Chiamato quando l'host completa le operazioni con il motore di compilazione.Called when the host is finished with this build engine. Annulla la registrazione dei logger e chiude i nodi.It unregisters loggers and shuts down nodes.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Ereditato da Object)
UnloadAllProjects()

Rimuove tutti i riferimenti agli oggetti Project dalla classe Engine.Removes all references to Project objects from the Engine.

UnloadProject(Project)

Rimuove il riferimento alla classe Project specificata dalla classe Engine.Removes the reference to the specified Project from the Engine.

UnregisterAllLoggers()

Annulla la registrazione di tutti i logger dalla classe Engine.Unregisters all loggers from the Engine.

Si applica a