MessageQueueTask 类

定义

命名空间:

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

程序集:

Microsoft.SqlServer.MSMQTask.dll

包含消息队列任务所用的方法和属性。 此类不能被继承。

public ref class MessageQueueTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::MessageQueueTask::IMessageQueueTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue 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.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue 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.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

Public NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask

继承

Object

DtsObject

Task

MessageQueueTask

属性

DtsTaskAttribute

实现

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

注解

消息队列任务类允许对象与消息排队队列（也称为MSMQ）的队列发送和接收消息。 运行 Microsoft 分布式事务处理协调器（MSDTC）时，允许参与分布式事务。 消息队列任务的单个实例要么向指定队列发送一条消息，要么从指定队列接收一条消息，并在必要时等待消息到达。 可以发送以下类型的消息：

• 字符串消息，作为属性的值提供。

• 数据文件消息，由指定数据文件的内容生成。

• 变量消息，由一个或多个 SQL Server Integration Services 变量的名称和值生成。

枚举 MQMessageType 决定了特定消息队列任务所使用的消息格式。

更多信息请参见 消息队列任务。

要让它们MessageQueueTask在API或SSIS设计器中工作，必须安装SQL Server Integration Services。 如果只安装了 SQL Server Data Tools（SSDT），此功能将无法使用。

Important

在配置消息队列任务发送消息时，您可以使用目前消息队列支持的加密算法之一，RC2和RC4来加密消息。 与较新的算法相比，这两种加密算法都被视为加密性很弱的算法，但消息队列尚不支持新的算法。 因此，在使用消息队列任务发送消息时，应考虑您的加密需要。

构造函数

名称	说明
MessageQueueTask()	初始化 MessageQueueTask 类的新实例。

属性

名称	说明
CurrentExecutingPackageID	获取或设置当前执行包的ID。
DataFileOverWritable	获取或设置一个布尔值，指示数据文件消息是否可以覆盖已有的数据文件。
DebugMode	获取或设置一个布尔值，指示对象是否处于调试模式，以及运行时是否应触发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。
DTSMessageLineageID	获取或设置消息的血统标识符。
DTSMessagePackageID	获取或设置消息源包的标识符。
DTSMessageVersionID	获取或设置消息的版本。
EncryptionAlgo	获取或设置用于加密私信消息正文的加密算法名称。
ErrorIfMessageTimeOut	获得或设置一个布尔值，指定任务在消息超时是否失败。
ExecutionValue	返回一个用户定义的对象。 此字段是只读的。 (继承自 Task)
MessageDataFile	当 设置为 MessageTypeDTSMQMessageType_DataFile时，获取或设置所用的数据文件名。
MessageString	当 设置为 MessageTypeDTSMQMessageType_String时，接收或设置消息为 。
MessageType	当 为 DTSMQType_Sender时，会获得或设置一个值，表示发送TaskType的消息类型。
MessageVariables	当枚 MQMessageType 举设置为 DTSMQMessageType_Variables时，获取或设置变量列表。
MsmqConnection	获取或设置MSMQ任务连接的名称。
OperationDescription	获取或设置操作的描述。
ReceiveMessageTimeOut	获取或设置一个值，指定接收消息超时前的秒数。
ReceiveMessageType	获取或设置 MQMessageType 一个值，指示接收的消息类型。
ReceiveVariableMessage	获取或设置用于存储消息的变量名称。
RemoveFromQueue	获取或设置一个布尔值，指定消息是否应从队列中移除。
SaveDataFileName	获取或设置接收数据文件消息保存的文件名称。
StringCompareType	一个值，指定字符串消息类型 TaskType 在为 DTSMQType_Receiver时的字符串比较方法。
StringCompareValue	当 为 TaskTypeDTSMQType_Receiver时，获取或设置字符串消息的 String 与 。
StringMessageToVariableName	获取或设置消息内容保存的变量名称。
SuspendRequired	获得或设置一个布尔值，指示任务在遇到断点时是否应暂停。 当遇到断点时，运行时引擎为任务和容器设置该值。
TargetServerVersion	包含消息队列任务所用的方法和属性。 此类不能被继承。 (继承自 Task)
TaskType	获取或设置一个值，指示消息任务是在发送还是接收。
Use2000Format	获取或设置一个布尔值，表示消息使用 SQL Server 2000 格式。
UseEncryption	获得或设置一个布尔值，表示消息是否使用加密。
Version	成员被淘汰;参见备注。 返回任务版本。 此属性为只读。 (继承自 Task)

方法

名称	说明
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格式保存的包（带有 the.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)	验证任务配置正确。