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.

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

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

public class TaskLoggingHelperExtension : TaskLoggingHelper

The TaskLoggingHelperExtension type exposes the following members.

  NameDescription
Public methodTaskLoggingHelperExtensionInfrastructure. Initializes a new instance of the TaskLoggingHelperExtension class with the task instance, primary resources, shared resources, and a Help keyword prefix.
Top

  NameDescription
Protected propertyBuildEngineGets the build engine that is associated with the task. (Inherited from TaskLoggingHelper.)
Public propertyHasLoggedErrorsGets a value that indicates whether the task has logged any errors through this logging helper object. (Inherited from TaskLoggingHelper.)
Public propertyHelpKeywordPrefixGets or sets the prefix used to compose Help keywords from resource names. (Inherited from TaskLoggingHelper.)
Protected propertyTaskNameGets the name of the parent task. (Inherited from TaskLoggingHelper.)
Public propertyTaskResourcesGets or sets the culture-specific resources used by the logging methods. (Inherited from TaskLoggingHelper.)
Public propertyTaskSharedResourcesInfrastructure. Gets or sets the shared UI and string resources.
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExtractMessageCodeExtracts the message code prefix from the given full message string. (Inherited from TaskLoggingHelper.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFormatResourceStringInfrastructure. 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[]).)
Public methodFormatStringFormats the given string using the given arguments. (Inherited from TaskLoggingHelper.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetResourceMessageGets the message from resource in task library. (Inherited from TaskLoggingHelper.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodLogCommandLine(String)Logs the command line for an underlying tool, executable file, or shell command of a task. (Inherited from TaskLoggingHelper.)
Public methodLogCommandLine(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.)
Public methodLogError(String, Object[])Logs an error with the specified message. (Inherited from TaskLoggingHelper.)
Public methodLogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs an error using the specified message and other error details. (Inherited from TaskLoggingHelper.)
Public methodLogErrorFromException(Exception)Logs an error using the message from the given exception. (Inherited from TaskLoggingHelper.)
Public methodLogErrorFromException(Exception, Boolean)Logs an error using the message, and optionally the stack trace, from the given exception. (Inherited from TaskLoggingHelper.)
Public methodLogErrorFromException(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.)
Public methodLogErrorFromResources(String, Object[])Logs an error using the specified resource string. (Inherited from TaskLoggingHelper.)
Public methodLogErrorFromResources(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.)
Public methodLogErrorWithCodeFromResources(String, Object[])Logs an error with an error code using the specified resource string. (Inherited from TaskLoggingHelper.)
Public methodLogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])Logs an error using the specified resource string and other error details. (Inherited from TaskLoggingHelper.)
Public methodLogExternalProjectFinishedHelps log the custom ExternalProjectFinishedEventArgs build event. (Inherited from TaskLoggingHelper.)
Public methodLogExternalProjectStartedHelps log the custom ExternalProjectStartedEventArgs build event. (Inherited from TaskLoggingHelper.)
Public methodLogMessage(String, Object[])Logs a message with the specified string. (Inherited from TaskLoggingHelper.)
Public methodLogMessage(MessageImportance, String, Object[])Logs a message with the specified string and importance. (Inherited from TaskLoggingHelper.)
Public methodLogMessageFromResources(String, Object[])Logs a message with the specified resource string. (Inherited from TaskLoggingHelper.)
Public methodLogMessageFromResources(MessageImportance, String, Object[])Logs a message with the specified resource string and importance. (Inherited from TaskLoggingHelper.)
Public methodLogMessageFromTextLogs an error message or warning from the given line of text. (Inherited from TaskLoggingHelper.)
Public methodLogMessagesFromFile(String)Logs errors, warnings, and messages for each line of text in the given file. (Inherited from TaskLoggingHelper.)
Public methodLogMessagesFromFile(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.)
Public methodLogMessagesFromStreamLogs an error message or warning from the given stream. (Inherited from TaskLoggingHelper.)
Public methodLogWarning(String, Object[])Logs a warning with the specified message. (Inherited from TaskLoggingHelper.)
Public methodLogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Logs a warning using the specified message and other warning details. (Inherited from TaskLoggingHelper.)
Public methodLogWarningFromException(Exception)Logs a warning using the message from the specified exception. (Inherited from TaskLoggingHelper.)
Public methodLogWarningFromException(Exception, Boolean)Logs a warning using the message, and optionally the stack trace, from the given exception. (Inherited from TaskLoggingHelper.)
Public methodLogWarningFromResources(String, Object[])Logs a warning using the specified resource string. (Inherited from TaskLoggingHelper.)
Public methodLogWarningFromResources(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.)
Public methodLogWarningWithCodeFromResources(String, Object[])Logs a warning with a warning code using the specified resource string. (Inherited from TaskLoggingHelper.)
Public methodLogWarningWithCodeFromResources(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.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft