DTSMessageQueueTask Object

DTS Programming

DTS Programming

DTSMessageQueueTask Object

The DTSMessageQueueTask object sends and receives messages to or from a queue of Message Queuing. It allows participation in distributed transactions when Microsoft® Distributed Transaction Coordinator (MS DTC) is running.

A single instance of the DTSMessageQueueTask either sends one or more messages to a specified queue or receives a single message from a specified queue, waiting, if necessary, for the message to arrive.

Three 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 global variables message, which is generated from the names and values of one or more Data Transformation Services (DTS) global variables.

Two types of messages can be received:

  • A string message. Various comparisons can be specified to determine whether the task returns success or failure.

  • A global variables message. The values of one or more global variables (specified by the message) in the local package can be updated. If any of the global variables do not exist in the local package, they are created.
Collections
DTSMQMessages Collection Properties Collection

Properties
DataFileNonOverwritable Property ReceiveMessageTimeout Property
Description Property ReceiveMessageType Property
DTSMessageLineageID Property RemoveFromQueue Property
DTSMessagePackageID Property SaveDataFileName Property
DTSMessageVersionID Property StringCompareType Property
ErrorIfReceiveMessageTimeout Property StringCompareValue Property
Name Property (DTS) TaskType Property
QueuePath Property  

Methods
Execute Method Messages Method

Remarks

The New method of the Tasks collection of the Package object returns a reference to a Task object. The CustomTask property of the Task object returns a reference to the appropriate custom task object.