MessageQueueTask Class

 

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)

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

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

NameDescription
System_CAPS_pubmethodMessageQueueTask()

Initializes a new instance of the MessageQueueTask class.

NameDescription
System_CAPS_pubpropertyCurrentExecutingPackageID

Gets or sets the ID of the current executing package.

System_CAPS_pubpropertyDataFileOverWritable

Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.

System_CAPS_pubpropertyDebugMode

Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running.

System_CAPS_pubpropertyDTSMessageLineageID

Gets or sets the message lineage identifier.

System_CAPS_pubpropertyDTSMessagePackageID

Gets or sets the identifier of the package that is the source of the message.

System_CAPS_pubpropertyDTSMessageVersionID

Gets or sets the version of the message.

System_CAPS_pubpropertyEncryptionAlgo

Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.

System_CAPS_pubpropertyErrorIfMessageTimeOut

Gets or sets a Boolean specifying whether the task fails when the message times out.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This field is read-only. (Inherited from Task.)

System_CAPS_pubpropertyMessageDataFile

Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile.

System_CAPS_pubpropertyMessageString

Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String.

System_CAPS_pubpropertyMessageType

Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender.

System_CAPS_pubpropertyMessageVariables

Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables.

System_CAPS_pubpropertyMsmqConnection

Gets or sets the name of the connection for the MSMQ task.

System_CAPS_pubpropertyOperationDescription

Gets or sets the description of the operation.

System_CAPS_pubpropertyReceiveMessageTimeOut

Gets or sets a value that specifies the number of seconds before a received message times out.

System_CAPS_pubpropertyReceiveMessageType

Gets or sets an MQMessageType value that indicates the message type to receive.

System_CAPS_pubpropertyReceiveVariableMessage

Gets or sets the name of the variable in which to store the message.

System_CAPS_pubpropertyRemoveFromQueue

Gets or sets a Boolean that specifies whether the message should be removed from the queue.

System_CAPS_pubpropertySaveDataFileName

Gets or sets the name of the file to which an incoming Data File message is saved.

System_CAPS_pubpropertyStringCompareType

A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.

System_CAPS_pubpropertyStringCompareValue

Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.

System_CAPS_pubpropertyStringMessageToVariableName

Gets or sets the name of the variable to which the message contents are saved.

System_CAPS_pubpropertySuspendRequired

Gets or sets a Boolean that indicates if the task should suspend when it encounters a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyTaskType

Gets or sets a value that indicates whether the message task is sending or receiving.

System_CAPS_pubpropertyUse2000Format

Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.

System_CAPS_pubpropertyUseEncryption

Gets or sets a Boolean indicating whether the message uses encryption.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.(Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved in XML format (with the.xml file name extension), use the Application.LoadPackage method.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true.(Inherited from Task.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the task is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

The Message Queue task class allows an object to send and receive messages to or from a queue of Message Queuing (also known as 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 SQL Server Data Tools (SSDT) is installed.

System_CAPS_importantImportant

When configuring the Message Queue task to send messages, you can use one of the encryption algorithms that are currently supported by the 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.

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

Return to top
Show: