TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper TaskLoggingHelper Class

Определение

Содержит вспомогательные методы ведения журнала, используемые задачами.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
Наследование
TaskLoggingHelperTaskLoggingHelperTaskLoggingHelperTaskLoggingHelper
Производный

Примеры

В следующем примере показан код для задачи, которая создает один или несколько каталогов.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;
		}
	}
}

Конструкторы

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

Открытый конструктор, который облегчает запись сообщений в журнал фабриками задач.Public constructor which can be used by task factories to assist them in logging messages.

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

Инициализирует новый экземпляр классаTaskLoggingHelper и сопоставляет его с указанным экземпляром задачи.Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.

Свойства

BuildEngine BuildEngine BuildEngine BuildEngine

Получает подсистему построения, сопоставленную с задачей.Gets the build engine that is associated with the task.

HasLoggedErrors HasLoggedErrors HasLoggedErrors HasLoggedErrors

Получает значение, указывающее, записала ли задача ошибки с помощью этого вспомогательного объекта ведения журнала.Gets a value that indicates whether the task has logged any errors through this logging helper object.

HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

Получает или задает префикс, используемый для составления ключевых слов справки из имен ресурсов.Gets or sets the prefix used to compose Help keywords from resource names.

TaskName TaskName TaskName TaskName

Получает имя родительской задачи.Gets the name of the parent task.

TaskResources TaskResources TaskResources TaskResources

Получает или задает ресурсы, относящиеся к языку и региональным параметрам и используемые методами ведения журнала.Gets or sets the culture-specific resources used by the logging methods.

Методы

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

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.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)

Определяет, равен ли заданный объект текущему объекту.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)

Извлекает префикс кода сообщения из заданной полной строки сообщения.Extracts the message code prefix from the given full message string.

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

Загружает указанную строку ресурса и при необходимости форматирует ее с использованием заданных аргументов.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[])

Форматирует заданную строку, используя указанные аргументы.Formats the given string using the given arguments.

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

Служит хэш-функцией по умолчанию.Serves as the default hash function.

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

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.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)

Получает сообщение из ресурса в библиотеке задач.Gets the message from resource in task library.

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

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

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

InitializeLifetimeService вызывается при активации удаленного объекта.InitializeLifetimeService is called when the remote object is activated.

Этот метод определяет, какое будет время существования объекта.This method will determine how long the lifetime for the object will be.

Потокобезопасный.Thread safe. Однако InitializeLifetimeService и MarkAsInactive должны вызываться только в этом порядке, вместе или не вызываться вообще, причем не более одного раза.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)

Заносит в журнал командную строку для базового средства, исполняемого файла или команды оболочки для задачи, используя заданный уровень важности.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)

Заносит в журнал командную строку для базового средства, исполняемого файла или команды оболочки для задачи.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[])

Заносит в журнал важное сообщение, используя указанную строку и другие сведения о сообщении.Logs a critical message using the specified string and other message details.

Потокобезопасный.Thread safe.

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

Заносит в журнал ошибку с заданным сообщением.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[])

Заносит в журнал ошибку, используя заданное сообщение и другие сведения об ошибке.Logs an error using the specified message and other error details.

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

Заносит в журнал ошибку, используя сообщение из заданного исключения.Logs an error using the message from the given exception.

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

Заносит в журнал ошибку, используя сообщение из заданного исключения, и при необходимости приводит трассировку стека.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)

Заносит в журнал ошибку, используя сообщение из заданного исключения и всех внутренних исключений, и при необходимости приводит трассировку стека.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[])

Заносит в журнал ошибку, используя заданную строку ресурса.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[])

Заносит в журнал ошибку, используя заданную строку ресурса и другие сведения об ошибке.Logs an error using the specified resource string and other error details.

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

Заносит в журнал ошибку с кодом ошибки, используя заданную строку ресурса.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[])

Заносит в журнал ошибку, используя заданную строку ресурса и другие сведения об ошибке.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)

Позволяет занести в журнал пользовательское событие построения ExternalProjectFinishedEventArgs.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)

Позволяет занести в журнал пользовательское событие построения ExternalProjectStartedEventArgs.Helps log the custom ExternalProjectStartedEventArgs build event.

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

Заносит в журнал сообщение с заданной строкой и важностью.Logs a message with the specified string and importance.

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

Заносит в журнал сообщение с заданной строкой.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)

Заносит в журнал сообщение, используя указанную строку и другие сведения о сообщении.Logs a message using the specified string and other message details.

Потокобезопасный.Thread safe.

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

Заносит в журнал сообщение с заданной строкой ресурса и важностью.Logs a message with the specified resource string and importance.

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

Заносит в журнал сообщение с заданной строкой ресурса.Logs a message with the specified resource string.

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

Заносит в журнал сообщение об ошибке или предупреждение из заданной строки текста.Logs an error message or warning from the given line of text.

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

Заносит в журнал ошибки, предупреждения и сообщения для каждой строки текста в заданном файле.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)

Заносит в журнал ошибки, предупреждения и сообщения для каждой строки текста в заданном файле.Logs errors, warnings, and messages for each line of text in the given file. Также заносит в журнал важность сообщений.Also logs the importance of messages.

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

Заносит в журнал сообщение об ошибке или предупреждение, используя сообщение из заданного потока.Logs an error message or warning from the given stream.

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

Заносит в журнал предупреждение с заданным сообщением.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[])

Заносит в журнал предупреждение, используя заданное сообщение и другие сведения о предупреждении.Logs a warning using the specified message and other warning details.

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

Заносит в журнал предупреждение, используя сообщение из заданного исключения.Logs a warning using the message from the specified exception.

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

Заносит в журнал предупреждение, используя сообщение из заданного исключения, и при необходимости приводит трассировку стека.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[])

Заносит в журнал предупреждение, используя заданную строку ресурса.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[])

Заносит в журнал предупреждение, используя заданную строку ресурса и другие сведения о предупреждении.Logs a warning using the specified resource string and other warning details.

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

Заносит в журнал предупреждение с кодом предупреждения, используя заданную строку ресурса.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[])

Заносит в журнал предупреждение с кодом предупреждения, используя заданную строку ресурса и другие сведения о предупреждении.Logs a warning with a warning code using the specified resource string and other warning details.

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

Уведомляет этот объект TaskLoggingHelper о том, что он больше не требуется.Notifies this TaskLoggingHelper that it is no longer needed.

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

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

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

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

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

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Применяется к