MessageQueueTask Class

Article
12/03/2008

Contains the methods and properties used by the Message Queue task. This class cannot be inherited.

Namespace: Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Assembly: Microsoft.SqlServer.MSMQTask (in microsoft.sqlserver.msmqtask.dll)

Syntax

'Declaration
Public NotInheritable Class MessageQueueTask
    Inherits Task
    Implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend

public sealed class MessageQueueTask : Task, IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, 
    IDTSSuspend

public ref class MessageQueueTask sealed : public Task, IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, 
    IDTSSuspend

public final class MessageQueueTask extends Task implements IDTSComponentPersist, IMessageQueueTask, 
    IDTSBreakpointSite, IDTSSuspend

public final class MessageQueueTask extends Task implements IDTSComponentPersist, IMessageQueueTask, 
    IDTSBreakpointSite, IDTSSuspend

Remarks

Updated text:14 April 2006

The Message Queue task class allows an object to send and receive messages to or from a queue of Message Queuing (MSMQ). Participation in distributed transactions is allowed when running the Microsoft Distributed Transaction Coordinator (MSDTC). A single instance of a Message Queue task either sends one message to a specified queue or receives a single message from a specified queue, and also waits, if necessary, for the message to arrive. The following types of messages can be sent:

A string message, which is supplied as the value of a property.
A data file message, which is generated from the contents of a specified data file.
A variables message, which is generated from the names and values of one or more SQL Server Integration Services variables.

The enumeration MQMessageType determines which message format is used by a specific Message Queue task.

For more information, see Message Queue Task.

For the MessageQueueTask to work in either the API or in SSIS Designer, you must install SQL Server Integration Services. This feature will not work if only Business Intelligence Development Studio is installed.

Important

When configuring the Message Queue task to send messages, you can use one of the encryption algorithms that are currently supported by Message Queuing, RC2 and RC4, to encrypt the message. Both of these encryption algorithms are now considered cryptographically weak compared to newer algorithms, which Message Queuing does not yet support. Therefore, you should consider your cryptography needs carefully when sending messages using the Message Queue task.

Inheritance Hierarchy

System.Object
   Microsoft.SqlServer.Dts.Runtime.DtsObject
     Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms