TaskLoggingHelper Class

Provides helper logging methods used by tasks.

Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (in Microsoft.Build.Utilities.v4.0.dll)

public class TaskLoggingHelper : MarshalByRefObject

The TaskLoggingHelper type exposes the following members.

  NameDescription
Public methodTaskLoggingHelper(ITask)Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.
Public methodTaskLoggingHelper(IBuildEngine, String)Public constructor which can be used by task factories to assist them in logging messages.
Top

  NameDescription
Protected propertyBuildEngineGets the build engine that is associated with the task.
Public propertyHasLoggedErrorsGets a value that indicates whether the task has logged any errors through this logging helper object.
Public propertyHelpKeywordPrefixGets or sets the prefix used to compose Help keywords from resource names.
Protected propertyTaskNameGets the name of the parent task.
Public propertyTaskResourcesGets or sets the culture-specific resources used by the logging methods.
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExtractMessageCodeExtracts the message code prefix from the given full message string.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatResourceStringLoads the specified resource string and optionally formats it using the given arguments.
Public methodFormatStringFormats the given string using the given arguments.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetResourceMessageGets the message from resource in task library.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceInitializeLifetimeService is called when the remote object is activated. This method will determine how long the lifetime for the object will be. Thread safe. However, InitializeLifetimeService and MarkAsInactive should only be called in that order, together or not at all, and no more than once. (Overrides MarshalByRefObject.InitializeLifetimeService().)
Public methodLogCommandLine(String)Logs the command line for an underlying tool, executable file, or shell command of a task.
Public methodLogCommandLine(MessageImportance, String)Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.
Public methodLogCriticalMessageLogs a critical message using the specified string and other message details. Thread safe.
Public methodLogError(String, Object[])Logs an error with the specified message.
Public methodLogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs an error using the specified message and other error details.
Public methodLogErrorFromException(Exception)Logs an error using the message from the given exception.
Public methodLogErrorFromException(Exception, Boolean)Logs an error using the message, and optionally the stack trace, from the given exception.
Public methodLogErrorFromException(Exception, Boolean, Boolean, String)Logs an error using the message, and optionally the stack-trace from the given exception and any inner exceptions.
Public methodLogErrorFromResources(String, Object[])Logs an error using the specified resource string.
Public methodLogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs an error using the specified resource string and other error details.
Public methodLogErrorWithCodeFromResources(String, Object[])Logs an error with an error code using the specified resource string.
Public methodLogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])Logs an error using the specified resource string and other error details.
Public methodLogExternalProjectFinishedHelps log the custom ExternalProjectFinishedEventArgs build event.
Public methodLogExternalProjectStartedHelps log the custom ExternalProjectStartedEventArgs build event.
Public methodLogMessage(String, Object[])Logs a message with the specified string.
Public methodLogMessage(MessageImportance, String, Object[])Logs a message with the specified string and importance.
Public methodLogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[])Logs a message using the specified string and other message details. Thread safe.
Public methodLogMessageFromResources(String, Object[])Logs a message with the specified resource string.
Public methodLogMessageFromResources(MessageImportance, String, Object[])Logs a message with the specified resource string and importance.
Public methodLogMessageFromTextLogs an error message or warning from the given line of text.
Public methodLogMessagesFromFile(String)Logs errors, warnings, and messages for each line of text in the given file.
Public methodLogMessagesFromFile(String, MessageImportance)Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages.
Public methodLogMessagesFromStreamLogs an error message or warning from the given stream.
Public methodLogWarning(String, Object[])Logs a warning with the specified message.
Public methodLogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs a warning using the specified message and other warning details.
Public methodLogWarningFromException(Exception)Logs a warning using the message from the specified exception.
Public methodLogWarningFromException(Exception, Boolean)Logs a warning using the message, and optionally the stack trace, from the given exception.
Public methodLogWarningFromResources(String, Object[])Logs a warning using the specified resource string.
Public methodLogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs a warning using the specified resource string and other warning details.
Public methodLogWarningWithCodeFromResources(String, Object[])Logs a warning with a warning code using the specified resource string.
Public methodLogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])Logs a warning with a warning code using the specified resource string and other warning details.
Public methodMarkAsInactiveNotifies this TaskLoggingHelper that it is no longer needed.
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft