TaskLoggingHelperExtension Class

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Enables logging of various messages. Also, enables loading and formatting of resources.

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.Tasks
Assembly:  Microsoft.Build.Tasks.Core (in Microsoft.Build.Tasks.Core.dll)

Syntax

'Declaration
Public Class TaskLoggingHelperExtension _
    Inherits TaskLoggingHelper
public class TaskLoggingHelperExtension : TaskLoggingHelper
public ref class TaskLoggingHelperExtension : public TaskLoggingHelper
type TaskLoggingHelperExtension =  
    class 
        inherit TaskLoggingHelper 
    end
public class TaskLoggingHelperExtension extends TaskLoggingHelper

The TaskLoggingHelperExtension type exposes the following members.

Constructors

  Name Description
Public method TaskLoggingHelperExtension Infrastructure. Initializes a new instance of the TaskLoggingHelperExtension class with the task instance, primary resources, shared resources, and a Help keyword prefix.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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
Public property TaskSharedResources Infrastructure. Gets or sets the shared UI and string resources.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. (Inherited from TaskLoggingHelper.)
Protected method Finalize (Inherited from Object.)
Public method FormatResourceString Infrastructure. Loads the specified resource string and optionally formats it using the given arguments. The current thread's culture is used for formatting.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 TaskLoggingHelper.FormatResourceString(String, array<Object[]).)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
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. (Inherited from TaskLoggingHelper.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method ToString (Inherited from Object.)

Top

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.Tasks Namespace