XMLTask 类

定义

包含用于运行多个XML任务的成员,具体取决于 OperationType 属性,属性是枚举中的 DTSXMLOperation 值。 此类不能被继承。

public ref class XMLTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::XMLTask::IDTSXMLTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("BE19D629-EC49-455C-9708-27E3849F3C2A")]
public sealed class XMLTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.XMLTask.IDTSXMLTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("935AC7BD-FEBE-4104-9E92-0D04136FFA27")]
public sealed class XMLTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.XMLTask.IDTSXMLTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("3A8B754B-0C03-4159-88DA-E3578D25A20B")]
public sealed class XMLTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.XMLTask.IDTSXMLTask
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("BE19D629-EC49-455C-9708-27E3849F3C2A")>]
type XMLTask = class
    inherit Task
    interface IDTSXMLTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("935AC7BD-FEBE-4104-9E92-0D04136FFA27")>]
type XMLTask = class
    inherit Task
    interface IDTSXMLTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.xmltask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.XMLTask.Localized), SamplesTag="SsisXmlTask", TaskContact="XML Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.XMLTaskUI.XMLTaskUI, Microsoft.SqlServer.XMLTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("3A8B754B-0C03-4159-88DA-E3578D25A20B")>]
type XMLTask = class
    inherit Task
    interface IDTSXMLTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
Public NotInheritable Class XMLTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IDTSXMLTask
继承
属性
实现

注解

更多信息请参见 XML任务

构造函数

名称 说明
XMLTask()

初始化 XMLTask 类的新实例。

属性

名称 说明
DebugMode

一个布尔值,指示任务是否应检查是否有断点被启用。

Destination

获取或设置连接名称或XML任务保存操作结果的变量名称。

DestinationType

获取或设置一个 DTSXMLSaveResultTo 枚举值,指示XML任务保存XML文档的目的地类型。

DiffAlgorithm

当 为 OperationTypeDiff时,获得或设置比较算法为 。

DiffGramDestination

获取或设置连接名称或XML任务保存DiffGram文档的变量名称。

DiffGramDestinationType

获取或设置一个值,表示XML任务保存DiffGram文档的目的地类型。

DiffOptions

获取或设置一个值,表示该操作在比较文档时使用的选项。

ExecutionValue

返回任务执行的结果。

FailOnDifference

获取或设置一个布尔值,指示如果XML文档未能按照验证模式验证,任务是否会失败。

FailOnValidationFail

获得或设置一个布尔值,指示验证失败时操作是否失败。

Namespaces

获取或设置XML任务的命名空间集合。

NodeList

获得一个 ArrayList 类,里面包含 XPath 操作生成的一组节点。

OperationType

获取或设置一个 DTSXMLOperation 枚举值,指示任务执行的操作类型,如验证或合并。

OverwriteDestination

获取或设置一个布尔值,指示操作是否覆盖已有的目标文件。

PutResultInOneNode

获得或设置一个布尔值,指示操作是否将结果置于一个节点。

SaveDiffGram

获取或设置一个布尔值,指示比较结果(一个DiffGram文档)是否被保存。

SaveOperationResult

获取或设置一个布尔值,指示XML任务是否保存Diff操作输出。

SecondOperand

获取或设置连接名称、变量或用户提供的文本,即使用两个操作数的操作中的第二个操作数。 第二个操作数可以是XML文档、DiffGram、XSLT、XPath或验证文档,具体取决于操作。

SecondOperandType

获取或设置一个值,表示包含XML文档、DiffGram、XSLT、XPath或验证文档的源类型。SecondOperand

Source

获取或设置连接名称、变量或操作所使用的源代码文本名称。

SourceType

从枚举中获取或设置 DTSXMLSourceType 一个值,指示包含操作所用XML文档的源类型。

SuspendRequired

获得或设置一个布尔值,指示任务在遇到断点时是否应暂停。 当遇到断点时,运行时引擎为任务和容器设置该值。

TargetServerVersion

包含用于运行多个XML任务的成员,具体取决于 OperationType 属性,属性是枚举中的 DTSXMLOperation 值。 此类不能被继承。

(继承自 Task)
ValidationDetails

包含用于运行多个XML任务的成员,具体取决于 OperationType 属性,属性是枚举中的 DTSXMLOperation 值。 此类不能被继承。

ValidationType

获取或设置一个 DTSXMLValidationType 枚举值,表示操作所使用的验证类型。

Version

成员被淘汰;参见备注。 返回任务版本。 此属性为只读。

(继承自 Task)
XPathOperation

获取或设置一个 DTSXMLXPathOperation 枚举值,指示要执行的XPath操作。

XPathStringSource

获取或设置XPath表达式的源。

XPathStringSourceType

从枚举中获取或设置 DTSXMLSourceType 一个值,指示包含该属性中 XPathStringSource XPath表达式的源类型。

方法

名称 说明
AcceptBreakpointManager(BreakpointManager)

把a BreakpointManager 传给任务。 任务将使用断点管理器创建、移除并检查断点状态。 该方法由运行时调用,不用于代码中。

CanUpdate(String)

成员被淘汰;参见备注。 一个布尔值,表示新包的 XML 是否可以更新旧包的 XML。

(继承自 Task)
Equals(Object)

确定两个对象实例是否相等。

(继承自 DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

他负责执行任务。

GetConnectionID(Connections, String)

获得包含连接ID的字符串。

(继承自 Task)
GetConnectionName(Connections, String)

获得包含连接名称的字符串。

(继承自 Task)
GetHashCode()

返回此实例的哈希代码。

(继承自 DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

初始化与该任务相关的属性。 该方法由运行时调用,不用于代码中。

LoadFromXML(XmlElement, IDTSInfoEvents)

你的应用代码无法调用此方法。 要加载保存为 .xml的包裹,请使用以下 LoadPackage(String, IDTSEvents) 方法。

ResumeExecution()

暂停后继续执行任务。 任务或容器由运行时引擎恢复。

SaveToXML(XmlDocument, IDTSInfoEvents)

你的应用代码无法调用此方法。 要将包保存为 .xml,请使用以下 SaveToXml(String, Package, IDTSEvents) 方法。

SuspendExecution()

表示可执行文件需要暂停。 该方法由运行时引擎调用。

Update(String)

成员被淘汰;参见备注。 如果 CanUpdate(String) 将 设置为 true,该方法将旧包 XML 更新为新的包 XML。

(继承自 Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

验证组件配置正确。

适用于