PROPID_M_ADMIN_QUEUE

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This property specifies the administration queue used for system-generated acknowledgment messages.

• Type Indicator
  VT_LPWSTR

• PROPVARIANT Field
  pwszVal

• Property Values
  Format name string of administration queue.

Remarks

The administration queue can be any nontransactional queue.

The acknowledgment messages sent to the queue can indicate whether the original message reached its destination queue, whether the message was retrieved by the receiving application, or a combination of both.

To request acknowledgment messages, specify PROPID_M_ADMIN_QUEUE and PROPID_M_ACKNOWLEDGE in the MQMSGPROPS structure and call MQSendMessage. If both properties are not included, no acknowledgment messages are generated.

To retrieve the format name of the administration queue from a message, specify PROPID_M_ADMIN_QUEUEand PROPID_M_ADMIN_QUEUE_LEN in the MQMSGPROPS structure. Then call MQReceiveMessage and examine the returned values.

Before using the returned value of PROPID_M_ADMIN_QUEUE, always inspect the returned value of PROPID_M_ADMIN_QUEUE_LEN to see if an administration queue was specified.

A returned value of 0 indicates that no administration queue was specified by the sending application.

A nonzero returned value indicates that the format name of an administration queue was returned by PROPID_M_ADMIN_QUEUE.

Examples

The following examples show how PROPID_M_ADMIN_QUEUE is specified in the MQMSGPROPS structure for setting and retrieving the administration queue format name.

To set the format name

aMsgPropId[i] = PROPID_M_ADMIN_QUEUE;       // Property ID
aMsgPropVar[i].vt = VT_LPWSTR;              // Type indicator
aMsgPropVar[i].pwszVal = wszAdminFormatNameBuffer;
i++;
aMsgPropId[i] = PROPID_M_ACKNOWLEDGE;       // Property ID
aMsgPropVar[i].vt = VT_UI1;                 // Type indicator
aMsgPropVar[i].bVal = MQMSG_ACKNOWLEDGMENT_FULL_RECEIVE;
i++;

To retrieve the format name

aMsgPropId[i] = PROPID_M_ADMIN_QUEUE;       // Property ID
aMsgPropVar[i].vt = VT_LPWSTR;              // Type indicator
aMsgPropVar[i].pwszVal = wszAdminFormatNameBuffer;
i++;
 
aMsgPropId[i] = PROPID_M_ADMIN_QUEUE_LEN;   // Property ID
aMsgPropVar[i].vt = VT_UI4;                 // Type indicator
aMsgPropVar[i].ulVal = dwAdminFormatNameBufferLength;
i++;

Requirements

See Also

Reference

MQReceiveMessage
MQSendMessage
PROPID_M_ACKNOWLEDGE
PROPID_M_ADMIN_QUEUE_LEN