EventHandlerClass 类
此 API 支持 SQL Server 2012 基础结构,但不能通过代码直接使用。
A container on a package or other containers that holds executable objects to run when specific events occur.
继承层次结构
System.Object
Microsoft.SqlServer.Dts.Runtime.Wrapper.EventHandlerClass
命名空间: Microsoft.SqlServer.Dts.Runtime.Wrapper
程序集: Microsoft.SqlServer.DTSRuntimeWrap(在 Microsoft.SqlServer.DTSRuntimeWrap.dll 中)
语法
声明
<GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public Class EventHandlerClass _
Implements EventHandler, IDTSEventHandler100, IDTSContainer100, IDTSSequence100, _
IDTSExecutable100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, _
IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
用法
Dim instance As EventHandlerClass
[GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class EventHandlerClass : EventHandler,
IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100,
IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100
[GuidAttribute(L"B8E051B0-2B05-49C7-A60F-20E877392D5E")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
public ref class EventHandlerClass : EventHandler,
IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100,
IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100
[<GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
type EventHandlerClass =
class
interface EventHandler
interface IDTSEventHandler100
interface IDTSContainer100
interface IDTSSequence100
interface IDTSExecutable100
interface IDTSExecutionMetrics100
interface IDTSPropertiesProvider100
interface IDTSName100
interface IDTSBreakpointSite100
interface IDTSSuspend100
interface IDTSPersist100
interface IDTSRuntimeObject100
end
public class EventHandlerClass implements EventHandler, IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
EventHandlerClass 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
![]() |
EventHandlerClass | 基础结构。Initializes a new instance of the EventHandlerClass class. |
页首
属性
名称 | 说明 | |
---|---|---|
![]() |
CreationName | 基础结构。Gets the name that is used by the runtime engine to create an instance of the EventHandlerClass. This property is read-only. |
![]() |
DebugMode | 基础结构。Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled. |
![]() |
DelayValidation | 基础结构。Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. |
![]() |
Description | 基础结构。Gets or sets the description of the EventHandlerClass object. |
![]() |
Disable | 基础结构。Gets a Boolean that indicates whether the EventHandlerClass object is disabled. |
![]() |
Executables | 基础结构。Gets a collection of executable objects in this container which run when the event occurs. This property is read-only. |
![]() |
ExecutionDuration | 基础结构。Gets a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. |
![]() |
ExecutionResult | 基础结构。Gets a value that indicates the success or failure of the execution of the EventHandlerClass object. |
![]() |
ExecutionStatus | 基础结构。Gets a value that indicates the current status of the execution of the EventHandlerClass object at the time of the call. |
![]() |
FailPackageOnFailure | 基础结构。Gets or sets a Boolean that indicates whether the package fails when a child container fails. This property is used on containers, not the package itself. |
![]() |
FailParentOnFailure | 基础结构。Gets or sets a Boolean that indicates whether the parent container fails when a child container fails. |
![]() |
ForcedExecutionValue | 基础结构。If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value the package returns. |
![]() |
ForceExecutionResult | 基础结构。Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. |
![]() |
ForceExecutionValue | 基础结构。Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. |
![]() |
ID | 基础结构。Gets the ID, which is a GUID, of the EventHandlerClass. The value is read-only. |
![]() |
IDTSSuspend100_SuspendRequired | 基础结构。Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered. |
![]() |
IsDefaultLocaleID | 基础结构。Gets a Boolean that indicates whether the container uses the default locale. This property is read-only. |
![]() |
IsolationLevel | 基础结构。Gets or sets the isolation level of the transaction in the EventHandlerClass object. |
![]() |
LocaleID | 基础结构。Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the EventHandlerClass object is executed. |
![]() |
LogEntryInfos | 基础结构。Gets a collection of log entry definitions. This property is read-only. |
![]() |
LoggingMode | 基础结构。Gets or sets a value from the DTSLoggingMode enumeration that indicates the logging mode of the container. |
![]() |
LoggingOptions | 基础结构。Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. |
![]() |
MaximumErrorCount | 基础结构。Gets or sets an Integer value that specifies the maximum number of errors that can occur before the EventHandlerClass object stops running. |
![]() |
Name | 基础结构。Gets or sets the name of the EventHandlerClass. |
![]() |
Parent | 基础结构。Gets the parent container. The value is read-only. |
![]() |
PrecedenceConstraints | 基础结构。Gets a collection of precedence constraints, if any, found on the executable objects in this container. This property is read-only. |
![]() |
Properties | 基础结构。Gets a collection of IDTSProperty100 objects. This property is read-only. |
![]() |
StartTime | 基础结构。Gets the time when the container starts execution. This property is read-only. |
![]() |
StopTime | 基础结构。Gets the time when the container stops execution. This property is read-only. |
![]() |
SuspendRequired | 基础结构。Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered. |
![]() |
TransactionOption | 基础结构。Gets or sets a value that indicates whether the container participates in transactions. |
![]() |
VariableDispenser | 基础结构。Gets a variable dispenser object so that variables associated with the container can be locked for reading or writing. |
![]() |
Variables | 基础结构。Gets a collection object that contains the variables associated with this container. This property is read-only. |
页首
方法
名称 | 说明 | |
---|---|---|
![]() |
AcceptBreakpointManager | 基础结构。Passes a IDTSBreakpointManager100 to a task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code. |
![]() |
ComputeExpressions | 基础结构。Computes the expressions of this EventHandlerClass object. |
![]() |
Equals | (从 Object 继承。) |
![]() |
Execute | 基础结构。Runs the application, container, or package as part of a package workflow. |
![]() |
Finalize | (从 Object 继承。) |
![]() |
GetExpression | 基础结构。Returns the expression for the specified property or nullnull 引用(在 Visual Basic 中为 Nothing) if no expression is assigned. |
![]() |
GetHashCode | (从 Object 继承。) |
![]() |
GetParentID | 基础结构。Gets the parent identifier of this container. |
![]() |
GetType | (从 Object 继承。) |
![]() |
IDTSSuspend100_ResumeExecution | 基础结构。Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
![]() |
IDTSSuspend100_SuspendExecution | 基础结构。Notifies that the executable needs to suspend. This method is called by the runtime engine. |
![]() |
LoadFromXML | 基础结构。Loads an EventHandlerClass from the specified XML document. |
![]() |
MemberwiseClone | (从 Object 继承。) |
![]() |
RegenerateID | 基础结构。Creates a new GUID for the container and updates the container ID property. |
![]() |
ResumeExecution | 基础结构。Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
![]() |
SaveToXML | 基础结构。Saves an EventHandlerClass to the specified XML document. |
![]() |
SetExpression | 基础结构。Assigns the specified expression to the property. Specify nullnull 引用(在 Visual Basic 中为 Nothing) to remove an existing expression from the property. |
![]() |
SuspendExecution | 基础结构。Notifies that the executable needs to suspend. This method is called by the runtime engine. |
![]() |
ToString | (从 Object 继承。) |
![]() |
Validate | 基础结构。Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. |
页首
注释
For more information, see DtsEventHandler.
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。