Export (0) Print
Expand All

XMLTask Class

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.

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

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

[GuidAttribute("294E0FA0-649E-4A8A-8769-3948E4DAE936")]
public sealed class XMLTask : Task, 
	IDTSXMLTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The XMLTask type exposes the following members.

  NameDescription
Public methodXMLTaskInitializes a new instance of the XMLTask class.
Top

  NameDescription
Public propertyDebugModeA Boolean that indicates if a task should check if any breakpoints are enabled.
Public propertyDestinationGets or sets the name of the connection or the variable to which the XML task saves the results of the operation.
Public propertyDestinationTypeGets or sets a DTSXMLSaveResultTo enumeration value that indicates the type of destination to which the XML task saves the XML document.
Public propertyDiffAlgorithmGets or sets the comparison algorithm to use when the OperationType is Diff.
Public propertyDiffGramDestinationGets or sets the name of the connection or the variable to which the XML task saves the DiffGram document.
Public propertyDiffGramDestinationTypeGets or sets a value that indicates the type of destination to which the XML task saves the DiffGram document.
Public propertyDiffOptionsGets or sets a value that indicates the options the operation uses when comparing documents.
Public propertyExecutionValueReturns the result of the task execution. (Overrides Task.ExecutionValue.)
Public propertyFailOnDifferenceGets or sets a Boolean that indicates whether the task fails if the XML document fails to validate according to the validation schema.
Public propertyFailOnValidationFailGets or sets a Boolean that indicates whether the operation fails when a validation fails.
Public propertyNamespacesGets or sets the collection of namespaces for the XML task.
Public propertyNodeListGets an ArrayList class that contains a collection of nodes that the XPath operation produces.
Public propertyOperationTypeGets or sets a DTSXMLOperation enumeration value that indicates the type of the operation that the task performs, such as validation or merging.
Public propertyOverwriteDestinationGets or sets a Boolean that indicates whether the operation overwrites existing destination files.
Public propertyPutResultInOneNodeGets or sets a Boolean that indicates whether the operation places the result in one node.
Public propertySaveDiffGramGets or sets a Boolean that indicates whether the comparison result, a DiffGram document, is saved.
Public propertySaveOperationResultGets or sets a Boolean that indicates whether the XML task saves the Diff operation output.
Public propertySecondOperandGets 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.
Public propertySecondOperandTypeGets 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.
Public propertySourceGets or sets the name of the connection, the variable, or the user-provided text that is the source the operation uses.
Public propertySourceTypeGets or sets a value from the DTSXMLSourceType enumeration that indicates the type of source that contains the XML document the operation uses.
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 propertyValidationTypeGets or sets a DTSXMLValidationType enumeration value that indicates the type of validation the operation uses.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)
Public propertyXPathOperationGets or sets a DTSXMLXPathOperation enumeration value that indicates the XPath operation to perform.
Public propertyXPathStringSourceGets or sets the source of the XPath expression.
Public propertyXPathStringSourceTypeGets 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

  NameDescription
Public methodAcceptBreakpointManagerPasses 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.
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 this 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 component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

For more information, see XML 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