XMLTask 类

定义

包含用于根据 OperationType 属性(这是来自 DTSXMLOperation 枚举的值)运行若干 XML 任务的成员。 此类不能被继承。

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

获取或设置一个值,该值指示包含在 SecondOperand 中找到的 XML 文档、DiffGram、XSLT、XPath 或验证文档的源的类型。

Source

获取或设置作为操作使用的源的连接的名称、变量或用户提供的文本。

SourceType

获取或设置一个来自 DTSXMLSourceType 枚举的值,该值指示包含操作使用的 XML 文档的源的类型。

SuspendRequired

获取或设置一个布尔值,该值指示在遇到断点时任务是否应挂起。 遇到断点时,将由任务和容器的运行时引擎设置此值。

TargetServerVersion (继承自 Task)
ValidationDetails
ValidationType

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

Version

***  成员已弃用; 请参阅 "备注"。 **_ 返回任务的版本。 此属性是只读的。

(继承自 Task)
XPathOperation

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

XPathStringSource

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

XPathStringSourceType

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

方法

AcceptBreakpointManager(BreakpointManager)

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)

***  成员已弃用; 请参阅 "备注"。 **如果设置为 true,则此方法用新包 XML 更新旧包 XML CanUpdate(String)

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

验证组件是否已正确配置。

适用于