WmiDataReaderTask Class

Article
04/26/2013

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.

Inheritance Hierarchy

System.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)

Syntax

'Declaration
<GuidAttribute("20793BA8-9511-4B60-A723-D17FA8011D30")> _
Public NotInheritable Class WmiDataReaderTask _
    Inherits Task _
    Implements IWmiDataReaderTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As WmiDataReaderTask

[GuidAttribute("20793BA8-9511-4B60-A723-D17FA8011D30")]
public sealed class WmiDataReaderTask : Task, 
    IWmiDataReaderTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"20793BA8-9511-4B60-A723-D17FA8011D30")]
public ref class WmiDataReaderTask sealed : public Task, 
    IWmiDataReaderTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("20793BA8-9511-4B60-A723-D17FA8011D30")>]
type WmiDataReaderTask =  
    class 
        inherit Task 
        interface IWmiDataReaderTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end

public final class WmiDataReaderTask extends Task implements IWmiDataReaderTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The WmiDataReaderTask type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

	Name	Description
	AcceptBreakpointManager	Passes a BreakpointManager reference to the WmiDataReaderTask 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 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).)
	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 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.

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