Export (0) Print
Expand All

WmiDataReaderTask Class

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

Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask.WmiDataReaderTask

Namespace:  Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask
Assembly:  Microsoft.SqlServer.WMIDRTask (in Microsoft.SqlServer.WMIDRTask.dll)

[GuidAttribute("07E3BB03-EF95-4AC2-B023-E647964BFD1A")]
public sealed class WmiDataReaderTask : Task, 
	IWmiDataReaderTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The WmiDataReaderTask type exposes the following members.

  NameDescription
Public methodWmiDataReaderTaskInitializes a new instance of the WmiDataReaderTask class.
Top

  NameDescription
Public propertyDebugModeA Boolean that indicates whether WmiDataReaderTask should check if breakpoints are enabled.
Public propertyDestinationGets or sets the name of the destination for the WmiDataReaderTask.
Public propertyDestinationTypeGets or sets a DestinationType value that indicates the type of destination, such as a file or a variable, used by the WmiDataReaderTask.
Public propertyExecutionValueGets an Object that contains the results of the WmiDataReaderTask task. (Overrides Task.ExecutionValue.)
Public propertyOutputGets or sets an Object that contains the results of the WmiDataReaderTask task.
Public propertyOutputTypeGets or sets a OutputType value that indicates the type of output, such as a DataTable or a string, returned by the WmiDataReaderTask.
Public propertyOverwriteDestinationGets or sets a OverwriteDestination value that determines how the WmiDataReaderTask should handle existing data in the destination specified by the Destination property.
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 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 used by the WmiDataReaderTask task.
Public propertyWqlQuerySourceGets or sets the source of the Windows Management Instrumentation Query Language (WQL) query to be executed by the WmiDataReaderTask.
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 WmiDataReaderTask.
Top

  NameDescription
Public methodAcceptBreakpointManagerPasses a BreakpointManager reference to the WmiDataReaderTask 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).)
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 WmiDataReaderTask 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.
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 return the results. The WQL query can either 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 Data Reader 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.

Community Additions

ADD
Show:
© 2014 Microsoft