Partager via


Classe EventHandlerClass

Cette API prend en charge l'infrastructure SQL Server 2012 et n'est pas destinée à être utilisée directement à partir de votre code.

A container on a package or other containers that holds executable objects to run when specific events occur.

Hiérarchie d'héritage

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.EventHandlerClass

Espace de noms :  Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly :  Microsoft.SqlServer.DTSRuntimeWrap (en Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntaxe

'Déclaration
<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
'Utilisation
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

Le type EventHandlerClass expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique EventHandlerClass Infrastructure. Initializes a new instance of the EventHandlerClass class.

Haut de la page

Propriétés

  Nom Description
Propriété publique CreationName Infrastructure. Gets the name that is used by the runtime engine to create an instance of the EventHandlerClass. This property is read-only.
Propriété publique DebugMode Infrastructure. Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.
Propriété publique DelayValidation Infrastructure. Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.
Propriété publique Description Infrastructure. Gets or sets the description of the EventHandlerClass object.
Propriété publique Disable Infrastructure. Gets a Boolean that indicates whether the EventHandlerClass object is disabled.
Propriété publique Executables Infrastructure. Gets a collection of executable objects in this container which run when the event occurs. This property is read-only.
Propriété publique ExecutionDuration Infrastructure. Gets a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
Propriété publique ExecutionResult Infrastructure. Gets a value that indicates the success or failure of the execution of the EventHandlerClass object.
Propriété publique ExecutionStatus Infrastructure. Gets a value that indicates the current status of the execution of the EventHandlerClass object at the time of the call.
Propriété publique FailPackageOnFailure Infrastructure. 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.
Propriété publique FailParentOnFailure Infrastructure. Gets or sets a Boolean that indicates whether the parent container fails when a child container fails.
Propriété publique ForcedExecutionValue Infrastructure. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value the package returns.
Propriété publique ForceExecutionResult Infrastructure. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.
Propriété publique ForceExecutionValue Infrastructure. Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.
Propriété publique ID Infrastructure. Gets the ID, which is a GUID, of the EventHandlerClass. The value is read-only.
Propriété publique IDTSSuspend100_SuspendRequired Infrastructure. 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.
Propriété publique IsDefaultLocaleID Infrastructure. Gets a Boolean that indicates whether the container uses the default locale. This property is read-only.
Propriété publique IsolationLevel Infrastructure. Gets or sets the isolation level of the transaction in the EventHandlerClass object.
Propriété publique LocaleID Infrastructure. Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the EventHandlerClass object is executed.
Propriété publique LogEntryInfos Infrastructure. Gets a collection of log entry definitions. This property is read-only.
Propriété publique LoggingMode Infrastructure. Gets or sets a value from the DTSLoggingMode enumeration that indicates the logging mode of the container.
Propriété publique LoggingOptions Infrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.
Propriété publique MaximumErrorCount Infrastructure. Gets or sets an Integer value that specifies the maximum number of errors that can occur before the EventHandlerClass object stops running.
Propriété publique Name Infrastructure. Gets or sets the name of the EventHandlerClass.
Propriété publique Parent Infrastructure. Gets the parent container. The value is read-only.
Propriété publique PrecedenceConstraints Infrastructure. Gets a collection of precedence constraints, if any, found on the executable objects in this container. This property is read-only.
Propriété publique Properties Infrastructure. Gets a collection of IDTSProperty100 objects. This property is read-only.
Propriété publique StartTime Infrastructure. Gets the time when the container starts execution. This property is read-only.
Propriété publique StopTime Infrastructure. Gets the time when the container stops execution. This property is read-only.
Propriété publique SuspendRequired Infrastructure. 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.
Propriété publique TransactionOption Infrastructure. Gets or sets a value that indicates whether the container participates in transactions.
Propriété publique VariableDispenser Infrastructure. Gets a variable dispenser object so that variables associated with the container can be locked for reading or writing.
Propriété publique Variables Infrastructure. Gets a collection object that contains the variables associated with this container. This property is read-only.

Haut de la page

Méthodes

  Nom Description
Méthode publique AcceptBreakpointManager Infrastructure. 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.
Méthode publique ComputeExpressions Infrastructure. Computes the expressions of this EventHandlerClass object.
Méthode publique Equals (hérité de Object.)
Méthode publique Execute Infrastructure. Runs the application, container, or package as part of a package workflow.
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetExpression Infrastructure. Returns the expression for the specified property or nullune référence Null (Nothing dans Visual Basic) if no expression is assigned.
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetParentID Infrastructure. Gets the parent identifier of this container.
Méthode publique GetType (hérité de Object.)
Méthode publique IDTSSuspend100_ResumeExecution Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Méthode publique IDTSSuspend100_SuspendExecution Infrastructure. Notifies that the executable needs to suspend. This method is called by the runtime engine.
Méthode publique LoadFromXML Infrastructure. Loads an EventHandlerClass from the specified XML document.
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique RegenerateID Infrastructure. Creates a new GUID for the container and updates the container ID property.
Méthode publique ResumeExecution Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Méthode publique SaveToXML Infrastructure. Saves an EventHandlerClass to the specified XML document.
Méthode publique SetExpression Infrastructure. Assigns the specified expression to the property. Specify nullune référence Null (Nothing dans Visual Basic) to remove an existing expression from the property.
Méthode publique SuspendExecution Infrastructure. Notifies that the executable needs to suspend. This method is called by the runtime engine.
Méthode publique ToString (hérité de Object.)
Méthode publique Validate Infrastructure. Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

Haut de la page

Notes

For more information, see DtsEventHandler.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Dts.Runtime.Wrapper