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) ，此功能将不起作用。

重要

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

构造函数

MessageQueueTask()

初始化 MessageQueueTask 类的新实例。

属性

CurrentExecutingPackageID	获取或设置当前执行的包的 ID。
DataFileOverWritable	获取或设置一个布尔值，该值指示数据文件消息是否可以覆盖现有数据文件。
DebugMode	获取或设置一个布尔值，该值指示对象是否处于调试模式，以及它是否应在运行时引发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。
DTSMessageLineageID	获取或设置消息沿袭标识符。
DTSMessagePackageID	获取或设置作为消息源的包的标识符。
DTSMessageVersionID	获取或设置消息的版本。
EncryptionAlgo	获取或设置用于加密私有消息的消息正文的加密算法的名称。
ErrorIfMessageTimeOut	获取或设置一个布尔值，该值指定在消息超时时任务是否失败。
ExecutionValue	返回用户定义对象。 此字段为只读。 (继承自 Task)
MessageDataFile	获取或设置在 MessageType 设置为 DTSMQMessageType_DataFile 时使用的数据文件名。
MessageString	获取或设置在 MessageType 设置为 DTSMQMessageType_String 时使用的消息。
MessageType	获取或设置一个值，该值指示在 TaskType 为 DTSMQType_Sender 时要发送的消息的类型。
MessageVariables	获取或设置在 MQMessageType 枚举设置为 DTSMQMessageType_Variables 时的变量列表。
MsmqConnection	获取或设置 MSMQ 任务的连接名称。
OperationDescription	获取或设置操作的说明。
ReceiveMessageTimeOut	获取或设置一个值，该值指定接收的消息在超时之前等待的秒数。
ReceiveMessageType	获取或设置一个 MQMessageType 值，该值指示要接收的消息类型。
ReceiveVariableMessage	获取或设置用于存储消息的变量的名称。
RemoveFromQueue	获取或设置一个布尔值，该值指定是否应从队列中删除消息。
SaveDataFileName	获取或设置传入的数据文件消息保存到的文件的名称。
StringCompareType	一个值，该值指定字符串消息类型的字符串比较方法（如果为 TaskTypeDTSMQType_Receiver）。
StringCompareValue	获取或设置字符串消息与字符串消息的比较时间的TaskTypeDTSMQType_Receiver字符串。
StringMessageToVariableName	获取或设置消息内容保存到的变量的名称。
SuspendRequired	获取或设置一个布尔值，该值指示任务在遇到断点时是否应挂起。 遇到断点时，将由任务和容器的运行时引擎设置此值。
TargetServerVersion	包含消息队列任务所使用的方法和属性。 此类不能被继承。 (继承自 Task)
TaskType	获取或设置一个值，该值指示是否正在发送或接收消息任务。
Use2000Format	获取或设置一个布尔值，该值指示消息使用 SQL Server 2000 格式。
UseEncryption	获取或设置一个布尔值，该值指示消息是否使用加密。
Version	*** 不推荐使用的成员；请参阅“备注”。 *** 返回任务的版本。 此属性为只读。 (继承自 Task)

方法

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 格式（具有 .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)	验证任务是否已正确配置。