XMLTask Members

Contains the members used to run several XML tasks, depending on the OperationType property, which is a value from the DTSXMLOperation enumeration. This class cannot be inherited.

The following tables list the members exposed by the XMLTask type.

Public Constructors

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

Top

Public Properties

  Name Description
ms215435.pubproperty(en-US,SQL.90).gif DebugMode A Boolean that indicates if a task should check if any breakpoints are enabled.
ms215435.pubproperty(en-US,SQL.90).gif Destination Gets or sets the name of the connection or the variable to which the XML task saves the results of the operation.
ms215435.pubproperty(en-US,SQL.90).gif DestinationType Gets or sets a DTSXMLSaveResultTo enumeration value that indicates the type of destination to which the XML task saves the XML document.
ms215435.pubproperty(en-US,SQL.90).gif DiffAlgorithm Gets or sets the comparison algorithm to use when the OperationType is Diff.
ms215435.pubproperty(en-US,SQL.90).gif DiffGramDestination Gets or sets the name of the connection or the variable to which the XML task saves the DiffGram document.
ms215435.pubproperty(en-US,SQL.90).gif DiffGramDestinationType Gets or sets a value that indicates the type of destination to which the XML task saves the DiffGram document.
ms215435.pubproperty(en-US,SQL.90).gif DiffOptions Gets or sets a value that indicates the options the operation uses when comparing documents.
ms215435.pubproperty(en-US,SQL.90).gif ExecutionValue Overridden. Returns the result of the task execution.
ms215435.pubproperty(en-US,SQL.90).gif FailOnDifference Gets or sets a Boolean that indicates whether the task fails if the XML document fails to validate according to the validation schema.
ms215435.pubproperty(en-US,SQL.90).gif FailOnValidationFail Gets or sets a Boolean that indicates whether the operation fails when a validation fails.
ms215435.pubproperty(en-US,SQL.90).gif NodeList Gets an ArrayList class that contains a collection of nodes that the XPath operation produces.
ms215435.pubproperty(en-US,SQL.90).gif OperationType Gets or sets a DTSXMLOperation enumeration value that indicates the type of the operation that the task performs, such as validation or merging.
ms215435.pubproperty(en-US,SQL.90).gif OverwriteDestination Gets or sets a Boolean that indicates whether the operation overwrites existing destination files.
ms215435.pubproperty(en-US,SQL.90).gif PutResultInOneNode Gets or sets a Boolean that indicates whether the operation places the result in one node.
ms215435.pubproperty(en-US,SQL.90).gif SaveDiffGram Gets or sets a Boolean that indicates whether the comparison result, a DiffGram document, is saved.
ms215435.pubproperty(en-US,SQL.90).gif SaveOperationResult Gets or sets a Boolean that indicates whether the XML task saves the Diff operation output.
ms215435.pubproperty(en-US,SQL.90).gif SecondOperand Gets or sets the name of the connection, the variable, or the user-provided text that is the second operand in an operation that uses two operands. The second operand may be an XML document, a DiffGram, an XSLT, an XPath, or a validating document, depending on the operation.
ms215435.pubproperty(en-US,SQL.90).gif SecondOperandType Gets or sets a value that indicates the type of source that contains the XML document, the DiffGram, the XSLT, the XPath, or the validating document, found in the SecondOperand.
ms215435.pubproperty(en-US,SQL.90).gif Source Gets or sets the name of the connection, the variable, or the user-provided text that is the source the operation uses.
ms215435.pubproperty(en-US,SQL.90).gif SourceType Gets or sets a value from the DTSXMLSourceType enumeration that indicates the type of source that contains the XML document the operation uses.
ms215435.pubproperty(en-US,SQL.90).gif 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.
ms215435.pubproperty(en-US,SQL.90).gif ValidationType Gets or sets a DTSXMLValidationType enumeration value that indicates the type of validation the operation uses.
ms215435.pubproperty(en-US,SQL.90).gif Version  Returns the version of the task. This property is read-only. (inherited from Task)
ms215435.pubproperty(en-US,SQL.90).gif WaitForMe  Returns a Boolean that indicates whether the parent container should wait for completion of this task. This property is read-only. (inherited from Task)
ms215435.pubproperty(en-US,SQL.90).gif XPathOperation Gets or sets a DTSXMLXPathOperation enumeration value that indicates the XPath operation to perform.
ms215435.pubproperty(en-US,SQL.90).gif XPathStringSource Gets or sets the source of the XPath expression.
ms215435.pubproperty(en-US,SQL.90).gif XPathStringSourceType Gets or sets a value from the DTSXMLSourceType enumeration that indicates the type of the source that contains the XPath expression in the XPathStringSource property.

Top

Public Methods

(see also Protected Methods )

  Name Description
ms215435.pubmethod(en-US,SQL.90).gif AcceptBreakpointManager Passes a BreakpointManager to a task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
ms215435.pubmethod(en-US,SQL.90).gif CanUpdate  (inherited from Task )
ms215435.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from DtsObject )
ms215435.pubmethod(en-US,SQL.90).gif Execute Overridden. Runs the task.
ms215435.pubmethod(en-US,SQL.90).gif GetConnectionID  (inherited from Task )
ms215435.pubmethod(en-US,SQL.90).gif GetConnectionName  (inherited from Task )
ms215435.pubmethod(en-US,SQL.90).gif GetHashCode  Returns the hash code for this instance. (inherited from DtsObject)
ms215435.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms215435.pubmethod(en-US,SQL.90).gif InitializeTask Overridden. Initializes the properties associated with this task. This method is called by the runtime and is not used in code.
ms215435.pubmethod(en-US,SQL.90).gif LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
ms215435.pubmethod(en-US,SQL.90).gifms215435.static(en-US,SQL.90).gif op_Equality  (inherited from DtsObject )
ms215435.pubmethod(en-US,SQL.90).gifms215435.static(en-US,SQL.90).gif op_Inequality  (inherited from DtsObject )
ms215435.pubmethod(en-US,SQL.90).gifms215435.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms215435.pubmethod(en-US,SQL.90).gif ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
ms215435.pubmethod(en-US,SQL.90).gif SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
ms215435.pubmethod(en-US,SQL.90).gif SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
ms215435.pubmethod(en-US,SQL.90).gif ToString  (inherited from Object )
ms215435.pubmethod(en-US,SQL.90).gif Update  (inherited from Task )
ms215435.pubmethod(en-US,SQL.90).gif Validate Overridden. Verifies that the component is properly configured.

Top

Protected Methods

  Name Description
ms215435.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms215435.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

XMLTask Class
Microsoft.SqlServer.Dts.Tasks.XMLTask Namespace