WmiEventWatcherTask Class

 

Contains the members used to configure and run a WMI Event Watcher task, which runs Windows Management Instrumentation (WMI) queries and returns WMI data about a computer system. This class cannot be inherited.

Namespace:   Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask
Assembly:  Microsoft.SqlServer.WMIEWTask (in Microsoft.SqlServer.WMIEWTask.dll)

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask.WmiEventWatcherTask

[<Sealed>]
[<GuidAttribute("3F9BD2DF-08F5-4809-8946-2A3694DBF6F3")>]
type WmiEventWatcherTask = 
    class
        inherit Task
        interface IWmiEventWatcherTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end

NameDescription
System_CAPS_pubmethodWmiEventWatcherTask()

Initializes a new instance of the WmiEventWatcherTask class.

NameDescription
System_CAPS_pubpropertyActionAtEvent

Determines how the WmiEventWatcherTask responds when the task receives a Windows Management Instrumentation (WMI) event.

System_CAPS_pubpropertyActionAtTimeout

Determines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.

System_CAPS_pubpropertyAfterEvent

Determines how the WmiEventWatcherTask responds when the task receives the specified Windows Management Instrumentation (WMI) event.

System_CAPS_pubpropertyAfterTimeout

Determines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.

System_CAPS_pubpropertyDebugMode

A Boolean indicating whether WmiEventWatcherTask should check if breakpoints are enabled.

System_CAPS_pubpropertyExecutionValue

Gets an Object that contains the results of the WmiEventWatcherTask task.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyNumberOfEvents

Gets or sets the number of Windows Management Instrumentation (WMI) events for which the WmiEventWatcherTask should watch.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyTimeout

Gets or sets the number of seconds the task should wait to receive a Windows Management Instrumentation (WMI) event before timing out.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

System_CAPS_pubpropertyWmiConnection

Gets or sets the name of the WMIConn class used by the WmiEventWatcherTask task.

System_CAPS_pubpropertyWqlQuerySource

Gets or sets the source of the Windows Management Instrumentation Query Language (WQL) query to be executed by the WmiEventWatcherTask.

System_CAPS_pubpropertyWqlQuerySourceType

Gets or sets a QuerySourceType value that indicates the source type, such as file connection or a variable, of the Windows Management Instrumentation Query Language (WQL) query to be executed by the WmiEventWatcherTask.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager reference to the WmiEventWatcherTask task. This method is called by the runtime and is not used in code.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the WmiEventWatcherTask task. This method is called by the runtime and is not used in code.(Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true.(Inherited from Task.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

The class uses a WMIConn connection to connect to a server, execute a Windows Management Instrumentation Query Language (WQL) query against it, and wait for events associated with the query to occur. The task then provides notification as to whether a WMI event occurred. The WQL query can be provided directly, or a variable or file connection can be used to dynamically provide WQL queries at execution time.

Similarly, this class can use either a file connection or variable to receive the results of the WQL query. The output type of the WQL query results can also be specified.

For more information about the features of this task, see WMI Event Watcher Task.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: