WmiEventWatcherTask Class

Article
04/26/2013

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("03CE90F7-220B-48BB-A1EB-8F279F76C02A")> _
Public NotInheritable Class WmiEventWatcherTask _
    Inherits Task _
    Implements IWmiEventWatcherTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As WmiEventWatcherTask

[GuidAttribute("03CE90F7-220B-48BB-A1EB-8F279F76C02A")]
public sealed class WmiEventWatcherTask : Task, 
    IWmiEventWatcherTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"03CE90F7-220B-48BB-A1EB-8F279F76C02A")]
public ref class WmiEventWatcherTask sealed : public Task, 
    IWmiEventWatcherTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("03CE90F7-220B-48BB-A1EB-8F279F76C02A")>]
type WmiEventWatcherTask =  
    class 
        inherit Task 
        interface IWmiEventWatcherTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end

public final class WmiEventWatcherTask extends Task implements IWmiEventWatcherTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The WmiEventWatcherTask type exposes the following members.

Constructors

	Name	Description
	WmiEventWatcherTask	Initializes a new instance of the WmiEventWatcherTask class.

Top

Properties

	Name	Description
	ActionAtEvent	Determines how the WmiEventWatcherTask responds when the task receives a Windows Management Instrumentation (WMI) event.
	ActionAtTimeout	Determines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.
	AfterEvent	Determines how the WmiEventWatcherTask responds when the task receives the specified Windows Management Instrumentation (WMI) event.
	AfterTimeout	Determines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.
	DebugMode	A Boolean indicating whether WmiEventWatcherTask should check if breakpoints are enabled.
	ExecutionValue	Gets an Object that contains the results of the WmiEventWatcherTask task. (Overrides Task.ExecutionValue.)
	NumberOfEvents	Gets or sets the number of Windows Management Instrumentation (WMI) events for which the WmiEventWatcherTask should watch.
	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.
	Timeout	Gets or sets the number of seconds the task should wait to receive a Windows Management Instrumentation (WMI) event before timing out.
	Version	* Member deprecated; see Remarks. * Returns the version of the task. This property is read-only. (Inherited from Task.)
	WmiConnection	Gets or sets the name of the WMIConn class used by the WmiEventWatcherTask task.
	WqlQuerySource	Gets or sets the source of the Windows Management Instrumentation Query Language (WQL) query to be executed by the WmiEventWatcherTask.
	WqlQuerySourceType	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.

Top

Methods

	Name	Description
	AcceptBreakpointManager	Passes a BreakpointManager reference to the WmiEventWatcherTask task. This method is called by the runtime and is not used in code.
	CanUpdate	* Member deprecated; see Remarks. * A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute	Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
	GetConnectionID	Gets a String containing the ID of the connection. (Inherited from Task.)
	GetConnectionName	Gets a String containing the name of the connection. (Inherited from Task.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeTask	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).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	SuspendExecution	Indicates that the executable needs to suspend. This method is called by the runtime engine.
	ToString	(Inherited from Object.)
	Update	* 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.)
	Validate	Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

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.

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.

Share via