共用方式為

TaskLoggingHelper Class

  • 發行項

Provides helper logging methods used by tasks.

MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Inheritance Hierarchy

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

Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.Core (in Microsoft.Build.Utilities.Core.dll)

Syntax

'Declaration
Public Class TaskLoggingHelper _
    Inherits MarshalByRefObject

public class TaskLoggingHelper : MarshalByRefObject

public ref class TaskLoggingHelper : public MarshalByRefObject

type TaskLoggingHelper =  
    class 
        inherit MarshalByRefObject 
    end

public class TaskLoggingHelper extends MarshalByRefObject

The TaskLoggingHelper type exposes the following members.

Constructors

  Name Description
Public method TaskLoggingHelper(ITask) Initializes a new instance of the TaskLoggingHelper class and associates it with the specified task instance.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method TaskLoggingHelper(IBuildEngine, String) Public constructor which can be used by task factories to assist them in logging messages.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Top

Properties

  Name Description
Protected property BuildEngine Gets the build engine that is associated with the task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property HasLoggedErrors Gets a value that indicates whether the task has logged any errors through this logging helper object.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected property TaskName Gets the name of the parent task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public property TaskResources Gets or sets the culture-specific resources used by the logging methods.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Top

Methods

  Name Description
Public method CreateObjRef Security Critical. (Inherited from MarshalByRefObject.)
Public method Equals (Inherited from Object.)
Public method ExtractMessageCode Extracts the message code prefix from the given full message string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected method Finalize (Inherited from Object.)
Public method FormatResourceString Loads the specified resource string and optionally formats it using the given arguments.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method FormatString Formats the given string using the given arguments.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method GetResourceMessage Gets the message from resource in task library.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method GetType (Inherited from Object.)
Public method 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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0. (Overrides MarshalByRefObject.InitializeLifetimeService.)
Public method LogCommandLine(String) Logs the command line for an underlying tool, executable file, or shell command of a task.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogCriticalMessage Logs a critical message using the specified string and other message details. Thread safe.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogError(String, array<Object[]) Logs an error with the specified message.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogError(String, String, String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs an error using the specified message and other error details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorFromException(Exception) Logs an error using the message from the given exception.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorFromException(Exception, Boolean) Logs an error using the message, and optionally the stack trace, from the given exception.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorFromResources(String, array<Object[]) Logs an error using the specified resource string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs an error using the specified resource string and other error details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorWithCodeFromResources(String, array<Object[]) Logs an error with an error code using the specified resource string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs an error using the specified resource string and other error details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogExternalProjectFinished Helps log the custom ExternalProjectFinishedEventArgs build event.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogExternalProjectStarted Helps log the custom ExternalProjectStartedEventArgs build event.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessage(String, array<Object[]) Logs a message with the specified string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessage(MessageImportance, String, array<Object[]) Logs a message with the specified string and importance.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, array<Object[]) Logs a message using the specified string and other message details. Thread safe.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessageFromResources(String, array<Object[]) Logs a message with the specified resource string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessageFromResources(MessageImportance, String, array<Object[]) Logs a message with the specified resource string and importance.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessageFromText Logs an error message or warning from the given line of text.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessagesFromFile(String) Logs errors, warnings, and messages for each line of text in the given file.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
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.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogMessagesFromStream Logs an error message or warning from the given stream.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarning(String, array<Object[]) Logs a warning with the specified message.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs a warning using the specified message and other warning details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningFromException(Exception) Logs a warning using the message from the specified exception.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningFromException(Exception, Boolean) Logs a warning using the message, and optionally the stack trace, from the given exception.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningFromResources(String, array<Object[]) Logs a warning using the specified resource string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs a warning using the specified resource string and other warning details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningWithCodeFromResources(String, array<Object[]) Logs a warning with a warning code using the specified resource string.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method LogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, array<Object[]) Logs a warning with a warning code using the specified resource string and other warning details.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Public method MarkAsInactive Notifies this TaskLoggingHelper that it is no longer needed.MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method ToString (Inherited from Object.)

Top

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Build.Utilities Namespace