TaskHostClass Class
This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.
For more information, see TaskHost.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dts.Runtime.Wrapper.TaskHostClass
Namespace: Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly: Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)
Syntax
'Declaration
<GuidAttribute("3A0263D5-875D-4BD4-A133-FC2EBFBAE434")> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public Class TaskHostClass _
Implements TaskHost, IDTSObjectHost100, IDTSTaskHost100, IDTSContainer100, _
IDTSExecutable100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, _
IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
'Usage
Dim instance As TaskHostClass
[GuidAttribute("3A0263D5-875D-4BD4-A133-FC2EBFBAE434")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class TaskHostClass : TaskHost,
IDTSObjectHost100, IDTSTaskHost100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100,
IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100,
IDTSPersist100, IDTSRuntimeObject100
[GuidAttribute(L"3A0263D5-875D-4BD4-A133-FC2EBFBAE434")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
public ref class TaskHostClass : TaskHost,
IDTSObjectHost100, IDTSTaskHost100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100,
IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100,
IDTSPersist100, IDTSRuntimeObject100
[<GuidAttribute("3A0263D5-875D-4BD4-A133-FC2EBFBAE434")>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
type TaskHostClass =
class
interface TaskHost
interface IDTSObjectHost100
interface IDTSTaskHost100
interface IDTSContainer100
interface IDTSExecutable100
interface IDTSEventsProvider100
interface IDTSExecutionMetrics100
interface IDTSPropertiesProvider100
interface IDTSName100
interface IDTSBreakpointSite100
interface IDTSSuspend100
interface IDTSPersist100
interface IDTSRuntimeObject100
end
public class TaskHostClass implements TaskHost, IDTSObjectHost100, IDTSTaskHost100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
The TaskHostClass type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
TaskHostClass | Infrastructure. Initializes a new instance of the TaskHostClass class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ApartmentThreaded | Infrastructure. For more information, see TaskHost. |
|
CreationName | Infrastructure. Gets the string that is used to create a TaskHostClass object. |
|
DebugMode | Infrastructure. Gets or sets a value that indicates whether the TaskHostClass object is in debug mode. |
|
DelayValidation | Infrastructure. Gets or sets a value that indicates whether validation of the task is delayed until run time. |
|
Description | Infrastructure. Gets or sets the description of the TaskHostClass object. |
|
Disable | Infrastructure. Gets or sets a value that indicates whether the TaskHostClass object is disabled. |
|
DisableEventHandlers | Infrastructure. Gets or sets a value that indicates whether the event handlers on task are disabled. |
|
EventHandlers | Infrastructure. Gets a collection of event handler objects. |
|
EventInfos | Infrastructure. Gets a collection of EventInfo objects. |
|
ExecutionDuration | Infrastructure. Gets a value that indicates the amount of time that the container spent in execution. |
|
ExecutionResult | Infrastructure. Gets a value that indicates the success or failure of the execution of the TaskHostClass object. |
|
ExecutionStatus | Infrastructure. Gets a value that indicates the current status of the execution of the TaskHostClass object at the time of the call. |
|
ExecutionValue | Infrastructure. Gets the result of the task execution. |
|
ExecValueVariable | Infrastructure. Gets or sets the custom variable that contains the execution value of the task. |
|
FailPackageOnFailure | Infrastructure. Gets or sets a value that indicates whether the package fails when a child container fails. |
|
FailParentOnFailure | Infrastructure. Gets or sets a value that indicates whether the parent container fails when a child container fails. |
|
ForcedExecutionValue | Infrastructure. Gets or sets an object that contains a container-defined value. |
|
ForceExecutionResult | Infrastructure. Gets or sets the execution result of the container. |
|
ForceExecutionValue | Infrastructure. Gets or sets a value that indicates whether the execution value of the container should be forced to contain a particular value. |
|
HostType | Infrastructure. Gets the value from the DTSObjectHostType enumeration that describes the host of the container. |
|
ID | Infrastructure. Gets a GUID that identifies the DTSForcedExecResult. |
|
IDTSContainer100_DelayValidation | Infrastructure. Gets or sets a value that indicates whether the validation is delayed. |
|
IDTSSuspend100_SuspendRequired | Infrastructure. Gets or sets a value that indicates whether the task should suspend when they encounter a breakpoint. |
|
InnerObject | Infrastructure. Gets the object that is contained by the TaskHostClass. |
|
IsDefaultLocaleID | Infrastructure. Gets a value that indicates whether the container uses the default locale. |
|
IsolationLevel | Infrastructure. Gets the isolation level of the TaskHostClass. |
|
LocaleID | Infrastructure. Gets or sets the locale id to use when the TaskHostClass object is executed. |
|
LogEntryInfos | Infrastructure. Gets a collection of IDTSLogEntryInfos100 object. |
|
LoggingMode | Infrastructure. Gets or sets the logging mode of the container. |
|
LoggingOptions | Infrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers. |
|
MaximumErrorCount | Infrastructure. Gets or sets a value that indicates the maximum number of errors. |
|
Name | Infrastructure. Gets or sets the name of the TaskHostClass. |
|
Parent | Infrastructure. Gets the parent container. |
|
Properties | Infrastructure. Gets a IDTSProperties100 collection that contains the properties associated with the task. |
|
StartTime | Infrastructure. Gets the time that the container began execution. |
|
StopTime | Infrastructure. Gets the time that the container ended execution. |
|
SuspendRequired | Infrastructure. Gets or set a value that indicates whether the task should suspend when they encounter a breakpoint. |
|
TransactionOption | Infrastructure. Gets or sets a DTSTransactionOption enumeration that indicates whether the container participates in transactions. |
|
VariableDispenser | Infrastructure. Gets a IDTSVariableDispenser100 object so variables associated with the container can be locked. |
|
Variables | Infrastructure. Gets a collection that contains the variables associated with this container. |
Top
Methods
| Name | Description | |
|---|---|---|
|
AcceptBreakpointManager | Infrastructure. This method is called by the run-time engine when a task or container is created. |
|
ComputeExpressions | Infrastructure. Computes expressions of the TaskHostClass object. |
|
Equals | (Inherited from Object.) |
|
Execute | Infrastructure. Runs the application. |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetExpression | Infrastructure. Returns a string that contains the expression for the specified property. |
|
GetHashCode | (Inherited from Object.) |
|
GetParentID | Infrastructure. Returns the parent identifier of the TaskHostClass object. |
|
GetType | (Inherited from Object.) |
|
IDTSSuspend100_ResumeExecution | Infrastructure. Resumes the suspend execution. |
|
IDTSSuspend100_SuspendExecution | Infrastructure. Suspends the execution. |
|
LoadFromXML | Infrastructure. Loads a package saves as XML format. |
|
MemberwiseClone | (Inherited from Object.) |
|
RegenerateID | Infrastructure. Creates a new GUID for the sequence. |
|
ResumeExecution | Infrastructure. Resumes execution of the task after pausing. |
|
SaveToXML | Infrastructure. Saves the package to XML format. |
|
SetExpression | Infrastructure. Assigns the specified expression to the property. |
|
SuspendExecution | Infrastructure. Called when the executable needs to suspend. |
|
ToString | (Inherited from Object.) |
|
Validate | Infrastructure. Allows the package to determine if it contains invalid settings that will prevent it from executing successfully. |
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.