Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 | |
---|---|---|
![]() |
DebugMode | A Boolean that indicates if a task should check if any breakpoints are enabled. |
![]() |
Destination | Gets or sets the name of the connection or the variable to which the XML task saves the results of the operation. |
![]() |
DestinationType | Gets or sets a DTSXMLSaveResultTo enumeration value that indicates the type of destination to which the XML task saves the XML document. |
![]() |
DiffAlgorithm | Gets or sets the comparison algorithm to use when the OperationType is Diff. |
![]() |
DiffGramDestination | Gets or sets the name of the connection or the variable to which the XML task saves the DiffGram document. |
![]() |
DiffGramDestinationType | Gets or sets a value that indicates the type of destination to which the XML task saves the DiffGram document. |
![]() |
DiffOptions | Gets or sets a value that indicates the options the operation uses when comparing documents. |
![]() |
ExecutionValue | Overridden. Returns the result of the task execution. |
![]() |
FailOnDifference | Gets or sets a Boolean that indicates whether the task fails if the XML document fails to validate according to the validation schema. |
![]() |
FailOnValidationFail | Gets or sets a Boolean that indicates whether the operation fails when a validation fails. |
![]() |
NodeList | Gets an ArrayList class that contains a collection of nodes that the XPath operation produces. |
![]() |
OperationType | Gets or sets a DTSXMLOperation enumeration value that indicates the type of the operation that the task performs, such as validation or merging. |
![]() |
OverwriteDestination | Gets or sets a Boolean that indicates whether the operation overwrites existing destination files. |
![]() |
PutResultInOneNode | Gets or sets a Boolean that indicates whether the operation places the result in one node. |
![]() |
SaveDiffGram | Gets or sets a Boolean that indicates whether the comparison result, a DiffGram document, is saved. |
![]() |
SaveOperationResult | Gets or sets a Boolean that indicates whether the XML task saves the Diff operation output. |
![]() |
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. |
![]() |
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. |
![]() |
Source | Gets or sets the name of the connection, the variable, or the user-provided text that is the source the operation uses. |
![]() |
SourceType | Gets or sets a value from the DTSXMLSourceType enumeration that indicates the type of source that contains the XML document the operation uses. |
![]() |
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. |
![]() |
ValidationType | Gets or sets a DTSXMLValidationType enumeration value that indicates the type of validation the operation uses. |
![]() |
Version | Returns the version of the task. This property is read-only. (inherited from Task) |
![]() |
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) |
![]() |
XPathOperation | Gets or sets a DTSXMLXPathOperation enumeration value that indicates the XPath operation to perform. |
![]() |
XPathStringSource | Gets or sets the source of the XPath expression. |
![]() |
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 | |
---|---|---|
![]() |
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. |
![]() |
CanUpdate | (inherited from Task ) |
![]() |
Equals | Overloaded. (inherited from DtsObject ) |
![]() |
Execute | Overridden. Runs the task. |
![]() |
GetConnectionID | (inherited from Task ) |
![]() |
GetConnectionName | (inherited from Task ) |
![]() |
GetHashCode | Returns the hash code for this instance. (inherited from DtsObject) |
![]() |
GetType | (inherited from Object ) |
![]() |
InitializeTask | Overridden. Initializes the properties associated with this task. This method is called by the runtime and is not used in code. |
![]() |
LoadFromXML | This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. |
![]() ![]() |
op_Equality | (inherited from DtsObject ) |
![]() ![]() |
op_Inequality | (inherited from DtsObject ) |
![]() ![]() |
ReferenceEquals | (inherited from Object ) |
![]() |
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 | (inherited from Task ) |
![]() |
Validate | Overridden. Verifies that the component is properly configured. |
Top
Protected Methods
Name | Description | |
---|---|---|
![]() |
Finalize | (inherited from Object ) |
![]() |
MemberwiseClone | (inherited from Object ) |
Top
See Also
Reference
XMLTask Class
Microsoft.SqlServer.Dts.Tasks.XMLTask Namespace