Share via


MSMQMessage.AdminQueueInfo

 

Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista

The AdminQueueInfo property of the MSMQMessage object specifies the queue used for Message Queuing-generated acknowledgment messages. This object is passed to the queue manager on the target computer.

Data type: MSMQQueueInfo
Run-time access: Read/write
Property AdminQueueInfo As MSMQQueueInfo  

Property Value

An MSMQQueueInfo object that represents the administration queue (in C++, a smart pointer to the IMSMQQueueInfo interface).

Remarks

The administration queue can be any nontransactional queue. Acknowledgment messages cannot be sent to a distribution list, a multicast address, or a multiple-element format name. The acknowledgment messages sent to the administration queue are Message Queuing-generated messages indicating whether the original message reached its destination queue and whether it was removed from the queue. For information on acknowledgment messages and administration queues, see Acknowledgment Messages and Administration Queues.

To obtain an MSMQQueueInfo object for the administration queue, the sending application must do one of the following:

To request acknowledgment messages, the sending application must set MSMQMessage.Ackand AdminQueueInfo when sending messages.

When setting the administration queue in an HTTP message, you must set the AdminQueueInfo property to an MSMQQueueInfo object initialized by setting its MSMQQueueInfo.FormatName property to an HTTP direct format name.

To find out if acknowledgment messages were requested, the receiving application can examine MSMQMessage.Ack and AdminQueueInfo when it reads the messages in the queue.

Equivalent API Function Property

With API function calls, the equivalent property for setting and retrieving the administration queue is PROPID_M_ADMIN_QUEUE.

For information on See
How administration queues are used Administration Queues
What is in an acknowledgment message Acknowledgment Messages
HTTP direct format names Direct Format Names

Example Code

The following example is included in Using Message Queuing.

For an example of See
Specifying the administration queue when requesting acknowledgment messages Visual Basic Code Example: Requesting Acknowledgment Messages

Requirements

Windows NT/2000/XP: Included in Windows NT 4.0 SP3 and later.

Windows 95/98/Me: Included in Windows 95 and later.

Header: Declared in Mqoai.h.

Library: Use Mqoa.lib

See Also

MSMQMessage
MSMQMessage.Ack
MSMQQuery.LookupQueue
MSMQQueueInfo
MSMQQueueInfo.Refresh
PROPID_M_ADMIN_QUEUE