TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper Class

Definizione

Fornisce i metodi di registrazione supporto utilizzati dalle attività.Provides helper logging methods used by tasks.

public ref class TaskLoggingHelper : MarshalByRefObject
public class TaskLoggingHelper : MarshalByRefObject
type TaskLoggingHelper = class
    inherit MarshalByRefObject
Public Class TaskLoggingHelper
Inherits MarshalByRefObject
Ereditarietà
TaskLoggingHelperTaskLoggingHelperTaskLoggingHelperTaskLoggingHelper
Derivato

Esempi

Nell'esempio seguente viene illustrato il codice per un'attività che consente di creare una o più directory.The following example shows the code for a task that creates one or more directories.

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;
		}
	}
}

Costruttori

TaskLoggingHelper(IBuildEngine, String) TaskLoggingHelper(IBuildEngine, String) TaskLoggingHelper(IBuildEngine, String) TaskLoggingHelper(IBuildEngine, String)

Costruttore pubblico che può essere utilizzato dalle factory delle attività per facilitare la registrazione dei messaggi.Public constructor which can be used by task factories to assist them in logging messages.

TaskLoggingHelper(ITask) TaskLoggingHelper(ITask) TaskLoggingHelper(ITask) TaskLoggingHelper(ITask)

Inizializza una nuova istanza della classe TaskLoggingHelper e la associa all'istanza di attività specificata.Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.

Proprietà

BuildEngine BuildEngine BuildEngine BuildEngine

Ottiene il motore di gestione della compilazione associato all'attività.Gets the build engine that is associated with the task.

HasLoggedErrors HasLoggedErrors HasLoggedErrors HasLoggedErrors

Ottiene un valore che indica se l'attività ha registrato eventuali errori attraverso questo oggetto di supporto della registrazione.Gets a value that indicates whether the task has logged any errors through this logging helper object.

HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

Ottiene o imposta il prefisso utilizzato per la composizione di parole chiave della Guida basate sui nomi delle risorse.Gets or sets the prefix used to compose Help keywords from resource names.

TaskName TaskName TaskName TaskName

Ottiene il nome dell'attività padre.Gets the name of the parent task.

TaskResources TaskResources TaskResources TaskResources

Ottiene o imposta le risorse specifiche delle impostazioni cultura utilizzate dai metodi di registrazione.Gets or sets the culture-specific resources used by the logging methods.

Metodi

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Consente di creare un oggetto che contiene tutte le informazioni rilevanti necessarie per la generazione del proxy utilizzato per effettuare la comunicazione con un oggetto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
ExtractMessageCode(String, String) ExtractMessageCode(String, String) ExtractMessageCode(String, String) ExtractMessageCode(String, String)

Estrae il prefisso del codice del messaggio della specifica stringa di messaggio completa.Extracts the message code prefix from the given full message string.

FormatResourceString(String, Object[]) FormatResourceString(String, Object[]) FormatResourceString(String, Object[]) FormatResourceString(String, Object[])

Carica la stringa di risorsa specificata e facoltativamente la formatta utilizzando gli argomenti specificati.Loads the specified resource string and optionally formats it using the given arguments.

FormatString(String, Object[]) FormatString(String, Object[]) FormatString(String, Object[]) FormatString(String, Object[])

Formatta la stringa specificata utilizzando gli argomenti specificati.Formats the given string using the given arguments.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Consente di recuperare l'oggetto servizio di durata corrente per controllare i criteri di durata per l'istanza.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetResourceMessage(String) GetResourceMessage(String) GetResourceMessage(String) GetResourceMessage(String)

Ottiene il messaggio dalla risorsa nella libreria di attività.Gets the message from resource in task library.

GetType() GetType() GetType() GetType()

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

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

InitializeLifetimeService viene chiamato quando l'oggetto remoto viene attivato.InitializeLifetimeService is called when the remote object is activated.

Questo metodo determinerà la durata dell'oggetto.This method will determine how long the lifetime for the object will be.

Thread-safe.Thread safe. Tuttavia, InitializeLifetimeService e MarkAsInactive devono essere chiamati solo in quell'ordine, insieme e non più di una volta.However, InitializeLifetimeService and MarkAsInactive should only be called in that order, together or not at all, and no more than once.

LogCommandLine(MessageImportance, String) LogCommandLine(MessageImportance, String) LogCommandLine(MessageImportance, String) LogCommandLine(MessageImportance, String)

Registra la riga di comando per uno strumento sottostante, un file eseguibile o per il comando di shell di un'attività utilizzando il livello di importanza specificato.Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.

LogCommandLine(String) LogCommandLine(String) LogCommandLine(String) LogCommandLine(String)

Registra la riga di comando per uno strumento sottostante, un file eseguibile o per il comando di shell di un'attività.Logs the command line for an underlying tool, executable file, or shell command of a task.

LogCriticalMessage(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogCriticalMessage(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogCriticalMessage(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogCriticalMessage(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un messaggio critico utilizzando la stringa specificata e altri dettagli del messaggio.Logs a critical message using the specified string and other message details.

Thread-safe.Thread safe.

LogError(String, Object[]) LogError(String, Object[]) LogError(String, Object[]) LogError(String, Object[])

Registra un errore con il messaggio specificato.Logs an error with the specified message.

LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un errore utilizzando il messaggio specificato e altri dettagli di errore.Logs an error using the specified message and other error details.

LogErrorFromException(Exception) LogErrorFromException(Exception) LogErrorFromException(Exception) LogErrorFromException(Exception)

Registra un errore utilizzando il messaggio ricevuto dall'eccezione indicata.Logs an error using the message from the given exception.

LogErrorFromException(Exception, Boolean) LogErrorFromException(Exception, Boolean) LogErrorFromException(Exception, Boolean) LogErrorFromException(Exception, Boolean)

Registra un errore utilizzando il messaggio (e, facoltativamente, la traccia dello stack) dall'eccezione indicata.Logs an error using the message, and optionally the stack trace, from the given exception.

LogErrorFromException(Exception, Boolean, Boolean, String) LogErrorFromException(Exception, Boolean, Boolean, String) LogErrorFromException(Exception, Boolean, Boolean, String) LogErrorFromException(Exception, Boolean, Boolean, String)

Registra un errore utilizzando il messaggio e, a scelta, la traccia dello stack forniti dall'eccezione indicata e da qualsiasi eccezione interna.Logs an error using the message, and optionally the stack-trace from the given exception and any inner exceptions.

LogErrorFromResources(String, Object[]) LogErrorFromResources(String, Object[]) LogErrorFromResources(String, Object[]) LogErrorFromResources(String, Object[])

Registra un errore utilizzando la stringa di risorsa specificata.Logs an error using the specified resource string.

LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un errore utilizzando la stringa di risorsa specificata e gli altri dettagli di errore.Logs an error using the specified resource string and other error details.

LogErrorWithCodeFromResources(String, Object[]) LogErrorWithCodeFromResources(String, Object[]) LogErrorWithCodeFromResources(String, Object[]) LogErrorWithCodeFromResources(String, Object[])

Registra un errore con un codice di errore, utilizzando la stringa di risorsa specificata.Logs an error with an error code using the specified resource string.

LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un errore utilizzando la stringa di risorsa specificata e gli altri dettagli di errore.Logs an error using the specified resource string and other error details.

LogExternalProjectFinished(String, String, String, Boolean) LogExternalProjectFinished(String, String, String, Boolean) LogExternalProjectFinished(String, String, String, Boolean) LogExternalProjectFinished(String, String, String, Boolean)

Semplifica la registrazione dell'evento di compilazione ExternalProjectFinishedEventArgs personalizzato.Helps log the custom ExternalProjectFinishedEventArgs build event.

LogExternalProjectStarted(String, String, String, String) LogExternalProjectStarted(String, String, String, String) LogExternalProjectStarted(String, String, String, String) LogExternalProjectStarted(String, String, String, String)

Semplifica la registrazione dell'evento di compilazione ExternalProjectStartedEventArgs personalizzato.Helps log the custom ExternalProjectStartedEventArgs build event.

LogMessage(MessageImportance, String, Object[]) LogMessage(MessageImportance, String, Object[]) LogMessage(MessageImportance, String, Object[]) LogMessage(MessageImportance, String, Object[])

Registra un messaggio con la stringa e l'importanza specificate.Logs a message with the specified string and importance.

LogMessage(String, Object[]) LogMessage(String, Object[]) LogMessage(String, Object[]) LogMessage(String, Object[])

Registra un messaggio con la stringa specificata.Logs a message with the specified string.

LogMessage(String, String, Object[], String, String, Int32, Int32, Int32, Int32, MessageImportance, String) LogMessage(String, String, Object[], String, String, Int32, Int32, Int32, Int32, MessageImportance, String) LogMessage(String, String, Object[], String, String, Int32, Int32, Int32, Int32, MessageImportance, String) LogMessage(String, String, Object[], String, String, Int32, Int32, Int32, Int32, MessageImportance, String)

Registra un messaggio utilizzando la stringa specificata e altri dettagli del messaggio.Logs a message using the specified string and other message details.

Thread-safe.Thread safe.

LogMessageFromResources(MessageImportance, String, Object[]) LogMessageFromResources(MessageImportance, String, Object[]) LogMessageFromResources(MessageImportance, String, Object[]) LogMessageFromResources(MessageImportance, String, Object[])

Registra un messaggio con la stringa di risorsa e l'importanza specificate.Logs a message with the specified resource string and importance.

LogMessageFromResources(String, Object[]) LogMessageFromResources(String, Object[]) LogMessageFromResources(String, Object[]) LogMessageFromResources(String, Object[])

Registra un messaggio con la stringa di risorsa specificata.Logs a message with the specified resource string.

LogMessageFromText(String, MessageImportance) LogMessageFromText(String, MessageImportance) LogMessageFromText(String, MessageImportance) LogMessageFromText(String, MessageImportance)

Registra un messaggio di errore o un avviso utilizzando la riga di testo specificata.Logs an error message or warning from the given line of text.

LogMessagesFromFile(String) LogMessagesFromFile(String) LogMessagesFromFile(String) LogMessagesFromFile(String)

Registra gli errori, gli avvisi e i messaggi per ogni riga di testo nel file specificato.Logs errors, warnings, and messages for each line of text in the given file.

LogMessagesFromFile(String, MessageImportance) LogMessagesFromFile(String, MessageImportance) LogMessagesFromFile(String, MessageImportance) LogMessagesFromFile(String, MessageImportance)

Registra gli errori, gli avvisi e i messaggi per ogni riga di testo nel file specificato.Logs errors, warnings, and messages for each line of text in the given file. Registra anche l'importanza dei messaggi.Also logs the importance of messages.

LogMessagesFromStream(TextReader, MessageImportance) LogMessagesFromStream(TextReader, MessageImportance) LogMessagesFromStream(TextReader, MessageImportance) LogMessagesFromStream(TextReader, MessageImportance)

Registra un messaggio di errore o un avviso utilizzando il flusso specificato.Logs an error message or warning from the given stream.

LogWarning(String, Object[]) LogWarning(String, Object[]) LogWarning(String, Object[]) LogWarning(String, Object[])

Registra un avviso con il messaggio specificato.Logs a warning with the specified message.

LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un avviso utilizzando il messaggio specificato e altri dettagli di avviso.Logs a warning using the specified message and other warning details.

LogWarningFromException(Exception) LogWarningFromException(Exception) LogWarningFromException(Exception) LogWarningFromException(Exception)

Registra un avviso utilizzando il messaggio ricevuto dall'eccezione specificata.Logs a warning using the message from the specified exception.

LogWarningFromException(Exception, Boolean) LogWarningFromException(Exception, Boolean) LogWarningFromException(Exception, Boolean) LogWarningFromException(Exception, Boolean)

Registra un avviso utilizzando il messaggio (e, facoltativamente, la traccia dello stack) dall'eccezione indicata.Logs a warning using the message, and optionally the stack trace, from the given exception.

LogWarningFromResources(String, Object[]) LogWarningFromResources(String, Object[]) LogWarningFromResources(String, Object[]) LogWarningFromResources(String, Object[])

Registra un avviso che utilizza la stringa di risorsa specificata.Logs a warning using the specified resource string.

LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un avviso che utilizza la stringa di risorsa specificata e gli altri dettagli di avviso.Logs a warning using the specified resource string and other warning details.

LogWarningWithCodeFromResources(String, Object[]) LogWarningWithCodeFromResources(String, Object[]) LogWarningWithCodeFromResources(String, Object[]) LogWarningWithCodeFromResources(String, Object[])

Registra un avviso con un codice di avviso, utilizzando la stringa di risorsa specificata.Logs a warning with a warning code using the specified resource string.

LogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) LogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])

Registra un avviso con un codice di avviso, utilizzando la stringa di risorsa specificata e gli altri dettagli dell'avviso.Logs a warning with a warning code using the specified resource string and other warning details.

MarkAsInactive() MarkAsInactive() MarkAsInactive() MarkAsInactive()

Notifica a TaskLoggingHelper che non è più necessario.Notifies this TaskLoggingHelper that it is no longer needed.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Crea una copia dei riferimenti dell'oggetto MarshalByRefObject corrente.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Si applica a