WmiDataReaderTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask

Assembly:

Microsoft.SqlServer.WMIDRTask.dll

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.

public ref class WmiDataReaderTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::WmiDataReaderTask::IWmiDataReaderTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.wmidatareadertask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask.Localized), SamplesTag="SsisWmiDataReaderTask", TaskContact="WMI Data Reader 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.WmiDataReaderTaskUI.WmiDataReaderTaskUI, Microsoft.SqlServer.WMIDRTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("EFBC62C2-738D-4191-A8C6-5AAF7A025C98")]
public sealed class WmiDataReaderTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask.IWmiDataReaderTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.wmidatareadertask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask.Localized), SamplesTag="SsisWmiDataReaderTask", TaskContact="WMI Data Reader 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.WmiDataReaderTaskUI.WmiDataReaderTaskUI, Microsoft.SqlServer.WMIDRTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("EFBC62C2-738D-4191-A8C6-5AAF7A025C98")>]
type WmiDataReaderTask = class
    inherit Task
    interface IWmiDataReaderTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class WmiDataReaderTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IWmiDataReaderTask

Inheritance

Object

DtsObject

Task

WmiDataReaderTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IWmiDataReaderTask

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.

Constructors

WmiDataReaderTask()

Initializes a new instance of the WmiDataReaderTask class.

Properties

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

Methods

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