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.

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

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

[GuidAttribute("BE19D629-EC49-455C-9708-27E3849F3C2A")]
public sealed class XMLTask : Task, IDTSXMLTask, IDTSBreakpointSite, 
	IDTSSuspend, IDTSComponentPersist

NameDescription
System_CAPS_pubmethodXMLTask()

Initializes a new instance of the XMLTask class.

NameDescription
System_CAPS_pubpropertyDebugMode

A Boolean that indicates if a task should check if any breakpoints are enabled.

System_CAPS_pubpropertyDestination

Gets or sets the name of the connection or the variable to which the XML task saves the results of the operation.

System_CAPS_pubpropertyDestinationType

Gets or sets a DTSXMLSaveResultTo enumeration value that indicates the type of destination to which the XML task saves the XML document.

System_CAPS_pubpropertyDiffAlgorithm

Gets or sets the comparison algorithm to use when the OperationType is Diff.

System_CAPS_pubpropertyDiffGramDestination

Gets or sets the name of the connection or the variable to which the XML task saves the DiffGram document.

System_CAPS_pubpropertyDiffGramDestinationType

Gets or sets a value that indicates the type of destination to which the XML task saves the DiffGram document.

System_CAPS_pubpropertyDiffOptions

Gets or sets a value that indicates the options the operation uses when comparing documents.

System_CAPS_pubpropertyExecutionValue

Returns the result of the task execution.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyFailOnDifference

Gets or sets a Boolean that indicates whether the task fails if the XML document fails to validate according to the validation schema.

System_CAPS_pubpropertyFailOnValidationFail

Gets or sets a Boolean that indicates whether the operation fails when a validation fails.

System_CAPS_pubpropertyNamespaces

Gets or sets the collection of namespaces for the XML task.

System_CAPS_pubpropertyNodeList

Gets an ArrayList class that contains a collection of nodes that the XPath operation produces.

System_CAPS_pubpropertyOperationType

Gets or sets a DTSXMLOperation enumeration value that indicates the type of the operation that the task performs, such as validation or merging.

System_CAPS_pubpropertyOverwriteDestination

Gets or sets a Boolean that indicates whether the operation overwrites existing destination files.

System_CAPS_pubpropertyPutResultInOneNode

Gets or sets a Boolean that indicates whether the operation places the result in one node.

System_CAPS_pubpropertySaveDiffGram

Gets or sets a Boolean that indicates whether the comparison result, a DiffGram document, is saved.

System_CAPS_pubpropertySaveOperationResult

Gets or sets a Boolean that indicates whether the XML task saves the Diff operation output.

System_CAPS_pubpropertySecondOperand

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.

System_CAPS_pubpropertySecondOperandType

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.

System_CAPS_pubpropertySource

Gets or sets the name of the connection, the variable, or the user-provided text that is the source the operation uses.

System_CAPS_pubpropertySourceType

Gets or sets a value from the DTSXMLSourceType enumeration that indicates the type of source that contains the XML document the operation uses.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyValidationDetails

System_CAPS_pubpropertyValidationType

Gets or sets a DTSXMLValidationType enumeration value that indicates the type of validation the operation uses.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

System_CAPS_pubpropertyXPathOperation

Gets or sets a DTSXMLXPathOperation enumeration value that indicates the XPath operation to perform.

System_CAPS_pubpropertyXPathStringSource

Gets or sets the source of the XPath expression.

System_CAPS_pubpropertyXPathStringSourceType

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.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

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.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

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

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

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

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the component is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

Return to top
Show: