TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper Class

Definición

Proporciona métodos de registro del asistente que usan las tareas.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
Herencia
TaskLoggingHelperTaskLoggingHelperTaskLoggingHelperTaskLoggingHelper
Derivado

Ejemplos

En el ejemplo siguiente se muestra el código de una tarea que crea uno o varios directorios.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;
		}
	}
}

Constructores

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

Constructor público que pueden usar los generadores de tareas como ayuda para el registro de mensajes.Public constructor which can be used by task factories to assist them in logging messages.

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

Inicializa una nueva instancia de la clase TaskLoggingHelper y la asocia con la instancia de tarea especificada.Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.

Propiedades

BuildEngine BuildEngine BuildEngine BuildEngine

Obtiene el motor de compilación asociado con la tarea.Gets the build engine that is associated with the task.

HasLoggedErrors HasLoggedErrors HasLoggedErrors HasLoggedErrors

Obtiene un valor que indica si la tarea ha registrado errores a través de este objeto del asistente de registro.Gets a value that indicates whether the task has logged any errors through this logging helper object.

HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

Obtiene o establece el prefijo usado para crear palabras clave de ayuda a partir de los nombres de recursos.Gets or sets the prefix used to compose Help keywords from resource names.

TaskName TaskName TaskName TaskName

Obtiene el nombre de la tarea principal.Gets the name of the parent task.

TaskResources TaskResources TaskResources TaskResources

Obtiene o establece los recursos específicos de la referencia cultural utilizados por los métodos de registro.Gets or sets the culture-specific resources used by the logging methods.

Métodos

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

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto 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 si el objeto especificado es igual al objeto actual.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)

Extrae el prefijo de código del mensaje de la cadena de mensaje completa especificada.Extracts the message code prefix from the given full message string.

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

Carga la cadena de recurso especificada y, de manera opcional, le da formato utilizando los argumentos especificados.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[])

Da formato a la cadena especificada utilizando los argumentos indicados.Formats the given string using the given arguments.

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

Sirve como la función hash predeterminada.Serves as the default hash function.

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

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.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)

Obtiene el mensaje del recurso en la biblioteca de tareas.Gets the message from resource in task library.

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

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

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

Se llama a InitializeLifetimeService cuando se activa el objeto remoto.InitializeLifetimeService is called when the remote object is activated.

Este método determinará la duración del objeto.This method will determine how long the lifetime for the object will be.

Seguro para subprocesos.Thread safe. Sin embargo, InitializeLifetimeService y MarkAsInactive debe llamarse únicamente en ese orden, juntos o no, y no más de una vez.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 línea de comandos para una herramienta subyacente, un archivo ejecutable o un comando shell de una tarea utilizando el nivel de importancia especificado.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 línea de comandos para una herramienta subyacente, un archivo ejecutable o un comando shell de una tarea.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 mensaje crítico usando la cadena especificada y otros detalles del mensaje.Logs a critical message using the specified string and other message details.

Seguro para subprocesos.Thread safe.

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

Registra un error con el mensaje especificado.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 error con el mensaje especificado y otros detalles del error.Logs an error using the specified message and other error details.

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

Registra un error con el mensaje de la excepción dada.Logs an error using the message from the given exception.

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

Registra un error con el mensaje y opcionalmente el seguimiento de pila de la excepción dada.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 error con el mensaje y, opcionalmente, el seguimiento de pila de la excepción dada y cualquier excepción 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 error con la cadena de recurso especificada.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 error con la cadena de recurso especificada y otros detalles del error.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 error con un código de error utilizando la cadena de recurso especificada.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 error con la cadena de recurso especificada y otros detalles del error.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)

Ayuda a registrar el evento de compilación ExternalProjectFinishedEventArgs personalizado.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)

Ayuda a registrar el evento de compilación ExternalProjectStartedEventArgs personalizado.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 mensaje con la cadena y la importancia especificadas.Logs a message with the specified string and importance.

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

Registra un mensaje con la cadena especificada.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 mensaje usando la cadena especificada y otros detalles del mensaje.Logs a message using the specified string and other message details.

Seguro para subprocesos.Thread safe.

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

Registra un mensaje con la cadena de recurso y la importancia especificadas.Logs a message with the specified resource string and importance.

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

Registra un mensaje con la cadena de recurso especificada.Logs a message with the specified resource string.

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

Registra un mensaje de error o advertencia de la línea de texto especificada.Logs an error message or warning from the given line of text.

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

Registra los errores, las advertencias y los mensajes para cada línea de texto del archivo especificado.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 los errores, las advertencias y los mensajes para cada línea de texto del archivo especificado.Logs errors, warnings, and messages for each line of text in the given file. También registra la importancia de los mensajes.Also logs the importance of messages.

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

Registra un mensaje de error o advertencia de la secuencia especificada.Logs an error message or warning from the given stream.

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

Registra una advertencia con el mensaje especificado.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 una advertencia utilizando el mensaje especificado y otros detalles de la advertencia.Logs a warning using the specified message and other warning details.

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

Registra una advertencia utilizando el mensaje de la excepción especificada.Logs a warning using the message from the specified exception.

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

Registra una advertencia con el mensaje y opcionalmente el seguimiento de pila de la excepción dada.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 una advertencia utilizando la cadena de recurso especificada.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 una advertencia utilizando la cadena de recurso especificada y otros detalles de la advertencia.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 una advertencia con un código de advertencia utilizando la cadena de recurso especificada.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 una advertencia con un código de advertencia utilizando la cadena de recurso especificada y otros detalles de la advertencia.Logs a warning with a warning code using the specified resource string and other warning details.

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

Notifica a este objeto TaskLoggingHelper que ya no se necesita.Notifies this TaskLoggingHelper that it is no longer needed.

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

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

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

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

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

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a