TaskLoggingHelperExtension Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

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

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

public class TaskLoggingHelperExtension : TaskLoggingHelper

NameDescription
System_CAPS_pubmethodTaskLoggingHelperExtension(ITask, ResourceManager, ResourceManager, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the TaskLoggingHelperExtension class with the task instance, primary resources, shared resources, and a Help keyword prefix.

NameDescription
System_CAPS_protpropertyBuildEngine

Gets the build engine that is associated with the task.(Inherited from TaskLoggingHelper.)

System_CAPS_pubpropertyHasLoggedErrors

Gets a value that indicates whether the task has logged any errors through this logging helper object.(Inherited from TaskLoggingHelper.)

System_CAPS_pubpropertyHelpKeywordPrefix

Gets or sets the prefix used to compose Help keywords from resource names.(Inherited from TaskLoggingHelper.)

System_CAPS_protpropertyTaskName

Gets the name of the parent task.(Inherited from TaskLoggingHelper.)

System_CAPS_pubpropertyTaskResources

Gets or sets the culture-specific resources used by the logging methods.(Inherited from TaskLoggingHelper.)

System_CAPS_pubpropertyTaskSharedResources

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the shared UI and string resources.

NameDescription
System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExtractMessageCode(String, String)

Extracts the message code prefix from the given full message string.(Inherited from TaskLoggingHelper.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFormatResourceString(String, Object[])

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the specified resource string and optionally formats it using the given arguments. The current thread's culture is used for formatting.(Overrides TaskLoggingHelper.FormatResourceString(String, Object[]).)

System_CAPS_pubmethodFormatString(String, Object[])

Formats the given string using the given arguments.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetResourceMessage(String)

Gets the message from resource in task library.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

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.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogCommandLine(MessageImportance, String)

Logs the command line for an underlying tool, executable file, or shell command of a task using the specified importance level.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogCommandLine(String)

Logs the command line for an underlying tool, executable file, or shell command of a task.(Inherited from TaskLoggingHelper.)

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

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

Thread safe.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogError(String, Object[])

Logs an error with the specified message.(Inherited from TaskLoggingHelper.)

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

Logs an error using the specified message and other error details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogErrorFromException(Exception)

Logs an error using the message from the given exception.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogErrorFromException(Exception, Boolean)

Logs an error using the message, and optionally the stack trace, from the given exception.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogErrorFromException(Exception, Boolean, Boolean, String)

Logs an error using the message, and optionally the stack-trace from the given exception and any inner exceptions.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogErrorFromResources(String, Object[])

Logs an error using the specified resource string.(Inherited from TaskLoggingHelper.)

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

Logs an error using the specified resource string and other error details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogErrorWithCodeFromResources(String, Object[])

Logs an error with an error code using the specified resource string.(Inherited from TaskLoggingHelper.)

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

Logs an error using the specified resource string and other error details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogExternalProjectFinished(String, String, String, Boolean)

Helps log the custom ExternalProjectFinishedEventArgs build event.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogExternalProjectStarted(String, String, String, String)

Helps log the custom ExternalProjectStartedEventArgs build event.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessage(MessageImportance, String, Object[])

Logs a message with the specified string and importance.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessage(String, Object[])

Logs a message with the specified string.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[])

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

Thread safe.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessageFromResources(MessageImportance, String, Object[])

Logs a message with the specified resource string and importance.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessageFromResources(String, Object[])

Logs a message with the specified resource string.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessageFromText(String, MessageImportance)

Logs an error message or warning from the given line of text.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessagesFromFile(String)

Logs errors, warnings, and messages for each line of text in the given file.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessagesFromFile(String, MessageImportance)

Logs errors, warnings, and messages for each line of text in the given file. Also logs the importance of messages.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogMessagesFromStream(TextReader, MessageImportance)

Logs an error message or warning from the given stream.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogWarning(String, Object[])

Logs a warning with the specified message.(Inherited from TaskLoggingHelper.)

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

Logs a warning using the specified message and other warning details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogWarningFromException(Exception)

Logs a warning using the message from the specified exception.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogWarningFromException(Exception, Boolean)

Logs a warning using the message, and optionally the stack trace, from the given exception.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogWarningFromResources(String, Object[])

Logs a warning using the specified resource string.(Inherited from TaskLoggingHelper.)

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

Logs a warning using the specified resource string and other warning details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodLogWarningWithCodeFromResources(String, Object[])

Logs a warning with a warning code using the specified resource string.(Inherited from TaskLoggingHelper.)

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

Logs a warning with a warning code using the specified resource string and other warning details.(Inherited from TaskLoggingHelper.)

System_CAPS_pubmethodMarkAsInactive()

Notifies this TaskLoggingHelper that it is no longer needed.(Inherited from TaskLoggingHelper.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

.NET Framework
Available since 2.0

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

Return to top
Show: