This topic has not yet been rated - Rate this topic

TaskLoggingHelper Class

Provides helper logging methods used by tasks.

System.Object
  System.MarshalByRefObject
    Microsoft.Build.Utilities.TaskLoggingHelper
      Microsoft.Build.Tasks.TaskLoggingHelperExtension

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.

  Name Description
Public method TaskLoggingHelper(ITask) Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.
Public method TaskLoggingHelper(IBuildEngine, String) Public constructor which can be used by task factories to assist them in logging messages.
Top
  Name Description
Protected property BuildEngine Gets the build engine that is associated with the task.
Public property HasLoggedErrors Gets a value that indicates whether the task has logged any errors through this logging helper object.
Public property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names.
Protected property TaskName Gets the name of the parent task.
Public property TaskResources Gets or sets the culture-specific resources used by the logging methods.
Top
  Name Description
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method ExtractMessageCode Extracts the message code prefix from the given full message string.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FormatResourceString Loads the specified resource string and optionally formats it using the given arguments.
Public method FormatString Formats the given string using the given arguments.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetResourceMessage Gets the message from resource in task library.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method LogCommandLine(String) Logs the command line for an underlying tool, executable file, or shell command of a task.
Public method LogCommandLine(MessageImportance, String) Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.
Public method LogError(String, Object[]) Logs an error with the specified message.
Public method LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) Logs an error using the specified message and other error details.
Public method LogErrorFromException(Exception) Logs an error using the message from the given exception.
Public method LogErrorFromException(Exception, Boolean) Logs an error using the message, and optionally the stack trace, from the given exception.
Public method LogErrorFromException(Exception, Boolean, Boolean, String) Logs an error using the message, and optionally the stack-trace from the given exception and any inner exceptions.
Public method LogErrorFromResources(String, Object[]) Logs an error using the specified resource string.
Public method LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) Logs an error using the specified resource string and other error details.
Public method LogErrorWithCodeFromResources(String, Object[]) Logs an error with an error code using the specified resource string.
Public method LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[]) Logs an error using the specified resource string and other error details.
Public method LogExternalProjectFinished Helps log the custom ExternalProjectFinishedEventArgs build event.
Public method LogExternalProjectStarted Helps log the custom ExternalProjectStartedEventArgs build event.
Public method LogMessage(String, Object[]) Logs a message with the specified string.
Public method LogMessage(MessageImportance, String, Object[]) Logs a message with the specified string and importance.
Public method LogMessageFromResources(String, Object[]) Logs a message with the specified resource string.
Public method LogMessageFromResources(MessageImportance, String, Object[]) Logs a message with the specified resource string and importance.
Public method LogMessageFromText Logs an error message or warning from the given line of text.
Public method LogMessagesFromFile(String) Logs errors, warnings, and messages for each line of text in the given file.
Public method LogMessagesFromFile(String, MessageImportance) Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages.
Public method LogMessagesFromStream Logs an error message or warning from the given stream.
Public method LogWarning(String, Object[]) Logs a warning with the specified message.
Public method LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) Logs a warning using the specified message and other warning details.
Public method LogWarningFromException(Exception) Logs a warning using the message from the specified exception.
Public method LogWarningFromException(Exception, Boolean) Logs a warning using the message, and optionally the stack trace, from the given exception.
Public method LogWarningFromResources(String, Object[]) Logs a warning using the specified resource string.
Public method LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[]) Logs a warning using the specified resource string and other warning details.
Public method LogWarningWithCodeFromResources(String, Object[]) Logs a warning with a warning code using the specified resource string.
Public method 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.
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method ToString Returns 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, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ