Task Classe

Definizione

Questa classe di base helper fornisce le funzionalità predefinite per le attività. È possibile creare un'istanza di questa classe solo in un formato derivato.

public ref class Task abstract : Microsoft::Build::Framework::ITask
public abstract class Task : Microsoft.Build.Framework.ITask
type Task = class
    interface ITask
Public MustInherit Class Task
Implements ITask
Ereditarietà
Task
Derivato
Implementazioni

Esempio

Nell'esempio seguente viene illustrato il codice per un'attività che crea una o più directory.

using System;
using System.IO;
using System.Security;
using System.Collections;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

namespace Microsoft.Build.Tasks
{
    /*
     * Class: MakeDir
     *
     * An MSBuild task that creates one or more directories.
     *
     */
    public class MakeDir : Task
    {
        // The Required attribute indicates the following to MSBuild:
        //	     - if the parameter is a scalar type, and it is not supplied, fail the build immediately
        //	     - if the parameter is an array type, and it is not supplied, pass in an empty array
        // In this case the parameter is an array type, so if a project fails to pass in a value for the
            // Directories parameter, the task will get invoked, but this implementation will do nothing,
            // because the array will be empty.
        [Required]
            // Directories to create.
        public ITaskItem[] Directories
        {
            get
            {
                return directories;
            }

            set
            {
                directories = value;
            }
        }

        // The Output attribute indicates to MSBuild that the value of this property can be gathered after the
        // task has returned from Execute(), if the project has an <Output> tag under this task's element for
        // this property.
        [Output]
        // A project may need the subset of the inputs that were actually created, so make that available here.
        public ITaskItem[] DirectoriesCreated
        {
            get
            {
                return directoriesCreated;
            }
        }

        private ITaskItem[] directories;
        private ITaskItem[] directoriesCreated;

        /// <summary>
        /// Execute is part of the Microsoft.Build.Framework.ITask interface.
        /// When it's called, any input parameters have already been set on the task's properties.
        /// It returns true or false to indicate success or failure.
        /// </summary>
        public override bool Execute()
        {
            ArrayList items = new ArrayList();
            foreach (ITaskItem directory in Directories)
            {
                // ItemSpec holds the filename or path of an Item
                if (directory.ItemSpec.Length > 0)
                {
                    try
                    {
                        // Only log a message if we actually need to create the folder
                        if (!Directory.Exists(directory.ItemSpec))
                        {
                            Log.LogMessage(MessageImportance.Normal, "Creating directory " + directory.ItemSpec);
                            Directory.CreateDirectory(directory.ItemSpec);
                        }

                        // Add to the list of created directories
                        items.Add(directory);
                    }
                    // If a directory fails to get created, log an error, but proceed with the remaining
                    // directories.
                    catch (Exception ex)
                    {
                        if (ex is IOException
                            || ex is UnauthorizedAccessException
                            || ex is PathTooLongException
                            || ex is DirectoryNotFoundException
                            || ex is SecurityException)
                        {
                            Log.LogError("Error trying to create directory " + directory.ItemSpec + ". " + ex.Message);
                        }
                        else
                        {
                            throw;
                        }
                    }
                }
            }

            // Populate the "DirectoriesCreated" output items.
            directoriesCreated = (ITaskItem[])items.ToArray(typeof(ITaskItem));

            // Log.HasLoggedErrors is true if the task logged any errors -- even if they were logged
            // from a task's constructor or property setter. As long as this task is written to always log an error
            // when it fails, we can reliably return HasLoggedErrors.
            return !Log.HasLoggedErrors;
        }
    }
}

Commenti

Questa classe astratta fornisce implementazioni predefinite per i metodi e le proprietà ITask dell'interfaccia .

È possibile creare un'istanza di questa classe solo in un formato derivato.

Costruttori

Task()

Costruttore predefinito (famiglia).

Task(ResourceManager)

Questo costruttore (famiglia) consente alle classi Task derivate di registrare le proprie risorse.

Task(ResourceManager, String)

Questo costruttore (famiglia) consente alle classi Task derivate di registrare le proprie risorse, nonché di fornire un prefisso per la composizione di parole chiave della Guida da nomi di risorse stringa. Se il prefisso è una stringa vuota, i nomi di risorse stringa verranno usati come parole chiave della Guida. Per un esempio di come viene usato il prefisso, vedere il metodo TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]).

Proprietà

BuildEngine

Il motore di compilazione imposta automaticamente questa proprietà per consentire alle attività di richiamarlo.

BuildEngine2

Il motore di compilazione imposta automaticamente questa proprietà per consentire alle attività di richiamarlo. Questa è una proprietà che consente agli autori di attività che ereditano da questa classe di non dovere eseguire il cast da IBuildEngine a IBuildEngine2.

BuildEngine3

Recupera la versione IBuildEngine3 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine4

Recupera la versione IBuildEngine4 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine5

Recupera la versione IBuildEngine5 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine6

Recupera la versione IBuildEngine6 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine7

Recupera la versione IBuildEngine7 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine8

Recupera la versione IBuildEngine8 dell'interfaccia del motore di compilazione fornita dall'host.

BuildEngine9

Recupera la versione IBuildEngine9 dell'interfaccia del motore di compilazione fornita dall'host.

HelpKeywordPrefix

Ottiene o imposta il prefisso usato per comporre parole chiave della Guida da nomi di risorse stringa. Se a un'attività non sono associate parole chiave della Guida, è possibile ignorare questa proprietà o impostarla su Null. Se il prefisso è impostato su una stringa vuota, i nomi di risorse stringa verranno usati come parole chiave della Guida. Per un esempio di come viene usato questo prefisso, vedere il metodo TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]).

HostObject

Il motore di compilazione imposta questa proprietà se l'IDE host ha associato un oggetto host a questa particolare attività.

Log

Ottiene un'istanza di una classe TaskLoggingHelper contenente i metodi di registrazione delle attività. taskLoggingHelper è un oggetto MarshallByRef per cui è necessario chiamare MarkAsInactive se l'attività padre crea il dominio app in cui esegue il marshalling di questo oggetto. Se il dominio app non viene scaricato alla fine dell'esecuzione dell'attività e il metodo MarkAsInactive non viene chiamato, si verifica una perdita delle istanze dell'attività nel dominio app in cui è stata creata l'attività.

TaskResources

Ottiene o imposta risorse specifiche delle impostazioni cultura dell'attività. Le classi derivate devono registrare le risorse durante la costruzione o tramite questa proprietà, se hanno stringhe localizzate.

Metodi

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
Execute()

Deve essere implementato dalla classe derivata.

GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Si applica a