TaskLoggingHelper Class

Definition

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
Inheritance
TaskLoggingHelper
Derived

Examples

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

Constructors

TaskLoggingHelper(IBuildEngine, String)

Public constructor which can be used by task factories to assist them in logging messages.

TaskLoggingHelper(ITask)

Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.

Properties

BuildEngine

Gets the build engine that is associated with the task.

HasLoggedErrors

Gets a value that indicates whether the task has logged any errors through this logging helper object.

HelpKeywordPrefix

Gets or sets the prefix used to compose Help keywords from resource names.

TaskName

Gets the name of the parent task.

TaskResources

Gets or sets the culture-specific resources used by the logging methods.

Methods

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)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
ExtractMessageCode(String, String)

Extracts the message code prefix from the given full message string.

FormatResourceString(String, Object[])

Loads the specified resource string and optionally formats it using the given arguments.

FormatString(String, Object[])

Formats the given string using the given arguments.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetResourceMessage(String)

Gets the message from resource in task library.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
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. However, InitializeLifetimeService and MarkAsInactive should only be called in that order, together or not at all, and no more than once.

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)

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[])

Logs a critical message using the specified string and other message details.

Thread safe.

LogError(String, Object[])

Logs an error with the specified message.

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

Logs an error using the specified message and other error details.

LogErrorFromException(Exception)

Logs an error using the message from the given exception.

LogErrorFromException(Exception, Boolean)

Logs an error using the message, and optionally the stack trace, from the given exception.

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[])

Logs an error using the specified resource string.

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[])

Logs an error with an error code using the specified resource string.

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)

Helps log the custom ExternalProjectFinishedEventArgs build event.

LogExternalProjectStarted(String, String, String, String)

Helps log the custom ExternalProjectStartedEventArgs build event.

LogMessage(MessageImportance, String, Object[])

Logs a message with the specified string and importance.

LogMessage(String, Object[])

Logs a message with the specified 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[])

Logs a message with the specified resource string and importance.

LogMessageFromResources(String, Object[])

Logs a message with the specified resource string.

LogMessageFromText(String, MessageImportance)

Logs an error message or warning from the given line of text.

LogMessagesFromFile(String)

Logs errors, warnings, and messages for each line of text in the given file.

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)

Logs an error message or warning from the given stream.

LogWarning(String, Object[])

Logs a warning with the specified message.

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

Logs a warning using the specified message and other warning details.

LogWarningFromException(Exception)

Logs a warning using the message from the specified exception.

LogWarningFromException(Exception, Boolean)

Logs a warning using the message, and optionally the stack trace, from the given exception.

LogWarningFromResources(String, Object[])

Logs a warning using the specified resource string.

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[])

Logs a warning with a warning code using the specified resource string.

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()

Notifies this TaskLoggingHelper that it is no longer needed.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to