WmiEventWatcherTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask

Assembly:

Microsoft.SqlServer.WMIEWTask.dll

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.

public ref class WmiEventWatcherTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::WmiEventWatcherTask::IWmiEventWatcherTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.wmieventwatchertask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask.Localized), SamplesTag="SsisWmiEventWatcherTask", TaskContact="WMI Event Watcher Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTaskUI.WmiEventWatcherTaskUI, Microsoft.SqlServer.WMIEWTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("DE6F9E8F-435D-4F98-BF59-0C03EF080720")]
public sealed class WmiEventWatcherTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask.IWmiEventWatcherTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.wmieventwatchertask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask.Localized), SamplesTag="SsisWmiEventWatcherTask", TaskContact="WMI Event Watcher Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTaskUI.WmiEventWatcherTaskUI, Microsoft.SqlServer.WMIEWTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("DE6F9E8F-435D-4F98-BF59-0C03EF080720")>]
type WmiEventWatcherTask = class
    inherit Task
    interface IWmiEventWatcherTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class WmiEventWatcherTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IWmiEventWatcherTask

Inheritance

Object

DtsObject

Task

WmiEventWatcherTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IWmiEventWatcherTask

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.

Constructors

WmiEventWatcherTask()

Initializes a new instance of the WmiEventWatcherTask class.

Properties

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.
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.
TargetServerVersion	(Inherited from Task)
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.

Methods

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