Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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.

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)
[GuidAttribute(L"36CA769C-EDAA-41d7-9FCA-E0789DC8E858")]
public ref class WmiEventWatcherTask sealed : public Task, 
	IWmiEventWatcherTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The WmiEventWatcherTask type exposes the following members.

  NameDescription
Public methodWmiEventWatcherTaskInitializes a new instance of the WmiEventWatcherTask class.
Top
  NameDescription
Public propertyActionAtEventDetermines how the WmiEventWatcherTask responds when the task receives a Windows Management Instrumentation (WMI) event.
Public propertyActionAtTimeoutDetermines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.
Public propertyAfterEventDetermines how the WmiEventWatcherTask responds when the task receives the specified Windows Management Instrumentation (WMI) event.
Public propertyAfterTimeoutDetermines how the WmiEventWatcherTask responds when the task times out without receiving the specified Windows Management Instrumentation (WMI) event.
Public propertyDebugModeA Boolean indicating whether WmiEventWatcherTask should check if breakpoints are enabled.
Public propertyExecutionValueGets an Object that contains the results of the WmiEventWatcherTask task. (Overrides Task::ExecutionValue.)
Public propertyNumberOfEventsGets or sets the number of Windows Management Instrumentation (WMI) events for which the WmiEventWatcherTask should watch.
Public propertySuspendRequiredGets 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.
Public propertyTimeoutGets or sets the number of seconds the task should wait to receive a Windows Management Instrumentation (WMI) event before timing out.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)
Public propertyWmiConnectionGets or sets the name of the WMIConn class used by the WmiEventWatcherTask task.
Public propertyWqlQuerySourceGets or sets the source of the Windows Management Instrumentation Query Language (WQL) query to be executed by the WmiEventWatcherTask.
Public propertyWqlQuerySourceTypeGets 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
  NameDescription
Public methodAcceptBreakpointManagerPasses a BreakpointManager reference to the WmiEventWatcherTask task. This method is called by the runtime and is not used in code.
Public methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task::Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes 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).)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application::SaveToXml method.
Public methodSuspendExecutionIndicates that the executable needs to suspend. This method is called by the runtime engine.
Public methodToString (Inherited from Object.)
Public methodUpdate*** 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.)
Public methodValidateVerifies that the task is properly configured. (Overrides Task::Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.