AppDomainIsolatedTask Class

Definition

Caution

AppDomains are no longer supported in .NET Core or .NET 5.0 or higher.

This class provides the same functionality as the Task class, but derives from MarshalByRefObject so that it can be instantiated in its own app domain.

public ref class AppDomainIsolatedTask abstract : MarshalByRefObject, Microsoft::Build::Framework::ITask
[Microsoft.Build.Framework.LoadInSeparateAppDomain]
public abstract class AppDomainIsolatedTask : MarshalByRefObject, Microsoft.Build.Framework.ITask
[Microsoft.Build.Framework.LoadInSeparateAppDomain]
[System.Obsolete("AppDomains are no longer supported in .NET Core or .NET 5.0 or higher.")]
public abstract class AppDomainIsolatedTask : MarshalByRefObject, Microsoft.Build.Framework.ITask
[<Microsoft.Build.Framework.LoadInSeparateAppDomain>]
type AppDomainIsolatedTask = class
    inherit MarshalByRefObject
    interface ITask
[<Microsoft.Build.Framework.LoadInSeparateAppDomain>]
[<System.Obsolete("AppDomains are no longer supported in .NET Core or .NET 5.0 or higher.")>]
type AppDomainIsolatedTask = class
    inherit MarshalByRefObject
    interface ITask
Public MustInherit Class AppDomainIsolatedTask
Inherits MarshalByRefObject
Implements ITask
Inheritance
AppDomainIsolatedTask
Derived
Attributes
Implements

Constructors

AppDomainIsolatedTask()

Default (family) constructor.

AppDomainIsolatedTask(ResourceManager)

This (family) constructor allows derived task classes to register their resources.

AppDomainIsolatedTask(ResourceManager, String)

This (family) constructor allows derived task classes to register their resources, as well as provide a prefix for composing help keywords from string resource names. If the prefix is an empty string, then string resource names will be used verbatim as help keywords. For an example of how the prefix is used, see the LogErrorWithCodeFromResources(String, Object[]) method.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the LogErrorWithCodeFromResources(String, Object[]) method.

HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

Log

Gets an instance of a TaskLoggingHelper class containing task logging methods.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

Methods

Execute()

Must be implemented by derived class.

InitializeLifetimeService()
Obsolete.

Overridden to give tasks deriving from this class infinite lease time. Otherwise we end up with a limited lease (5 minutes I think) and task instances can expire if they take long time processing.

Applies to