Partager via


Classe XMLTask

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.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Dts.Tasks.XMLTask
Assembly :  Microsoft.SqlServer.XMLTask (en Microsoft.SqlServer.XMLTask.dll)

Syntaxe

'Déclaration
<GuidAttribute("0656BAF4-02C2-4413-B57C-77852EA9B106")> _
Public NotInheritable Class XMLTask _
    Inherits Task _
    Implements IDTSXMLTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Utilisation
Dim instance As XMLTask
[GuidAttribute("0656BAF4-02C2-4413-B57C-77852EA9B106")]
public sealed class XMLTask : Task, 
    IDTSXMLTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"0656BAF4-02C2-4413-B57C-77852EA9B106")]
public ref class XMLTask sealed : public Task, 
    IDTSXMLTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("0656BAF4-02C2-4413-B57C-77852EA9B106")>]
type XMLTask =  
    class
        inherit Task
        interface IDTSXMLTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end
public final class XMLTask extends Task implements IDTSXMLTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

Le type XMLTask expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique XMLTask Initializes a new instance of the XMLTask class.

Haut de la page

Propriétés

  Nom Description
Propriété publique DebugMode A Boolean that indicates if a task should check if any breakpoints are enabled.
Propriété publique Destination Gets or sets the name of the connection or the variable to which the XML task saves the results of the operation.
Propriété publique DestinationType Gets or sets a DTSXMLSaveResultTo enumeration value that indicates the type of destination to which the XML task saves the XML document.
Propriété publique DiffAlgorithm Gets or sets the comparison algorithm to use when the OperationType is Diff.
Propriété publique DiffGramDestination Gets or sets the name of the connection or the variable to which the XML task saves the DiffGram document.
Propriété publique DiffGramDestinationType Gets or sets a value that indicates the type of destination to which the XML task saves the DiffGram document.
Propriété publique DiffOptions Gets or sets a value that indicates the options the operation uses when comparing documents.
Propriété publique ExecutionValue Returns the result of the task execution. (remplace Task. . :: . .ExecutionValue.)
Propriété publique FailOnDifference Gets or sets a Boolean that indicates whether the task fails if the XML document fails to validate according to the validation schema.
Propriété publique FailOnValidationFail Gets or sets a Boolean that indicates whether the operation fails when a validation fails.
Propriété publique NodeList Gets an ArrayList class that contains a collection of nodes that the XPath operation produces.
Propriété publique OperationType Gets or sets a DTSXMLOperation enumeration value that indicates the type of the operation that the task performs, such as validation or merging.
Propriété publique OverwriteDestination Gets or sets a Boolean that indicates whether the operation overwrites existing destination files.
Propriété publique PutResultInOneNode Gets or sets a Boolean that indicates whether the operation places the result in one node.
Propriété publique SaveDiffGram Gets or sets a Boolean that indicates whether the comparison result, a DiffGram document, is saved.
Propriété publique SaveOperationResult Gets or sets a Boolean that indicates whether the XML task saves the Diff operation output.
Propriété publique 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.
Propriété publique 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.
Propriété publique Source Gets or sets the name of the connection, the variable, or the user-provided text that is the source the operation uses.
Propriété publique SourceType Gets or sets a value from the DTSXMLSourceType enumeration that indicates the type of source that contains the XML document the operation uses.
Propriété publique 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.
Propriété publique ValidationType Gets or sets a DTSXMLValidationType enumeration value that indicates the type of validation the operation uses.
Propriété publique Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (hérité de Task.)
Propriété publique XPathOperation Gets or sets a DTSXMLXPathOperation enumeration value that indicates the XPath operation to perform.
Propriété publique XPathStringSource Gets or sets the source of the XPath expression.
Propriété publique 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.

Haut de la page

Méthodes

  Nom Description
Méthode publique 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.
Méthode publique CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (hérité de Task.)
Méthode publique Equals Determines whether two object instances are equal. (hérité de DtsObject.)
Méthode publique Execute Runs the task. (remplace Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetConnectionID Gets a String containing the ID of the connection. (hérité de Task.)
Méthode publique GetConnectionName Gets a String containing the name of the connection. (hérité de Task.)
Méthode publique GetHashCode Returns the hash code for this instance. (hérité de DtsObject.)
Méthode publique GetType (hérité de Object.)
Méthode publique InitializeTask Initializes the properties associated with this task. This method is called by the runtime and is not used in code. (remplace Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Méthode publique LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method.
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Méthode publique SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method.
Méthode publique SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
Méthode publique ToString (hérité de Object.)
Méthode publique Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (hérité de Task.)
Méthode publique Validate Verifies that the component is properly configured. (remplace Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Haut de la page

Notes

For more information, see Tâche XML.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.