MSMQOutgoingQueueManagement
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
(Introduced in MSMQ 3.0.) The MSMQOutgoingQueueManagement object represents the state of an outgoing queue. It can be used to do the following.
Obtain exactly-once-delivery information about transactional messages in the outgoing queue.
Pause and restart the sending of messages to their destination queues.
Resend a pending transaction sequence.
Obtain administrative information that is specific to an outgoing queue.
This object is implicitly created by a call to the MSMQManagement.Init method.
Methods
The MSMQOutgoingQueueManagement object defines the following methods.
| Method | Description |
|---|---|
| MSMQOutgoingQueueManagement.EodGetSendInfo | Returns an MSMQCollection object that contains exactly-once-delivery information for the outgoing queue. |
| MSMQOutgoingQueueManagement.EodResend | Resends the pending transaction sequence. |
| MSMQOutgoingQueueManagement.Pause | Stops the transmission of messages out of the outgoing queue. |
| MSMQOutgoingQueueManagement.Resume | Restarts the transmission of messages out of the outgoing queue. |
Properties
The MSMQOutgoingQueueManagement object defines the following properties.
| Property | Description |
|---|---|
| MSMQOutgoingQueueManagement.NextHops | Returns the address for routing messages to the destination queue in the next hop. Run-time access: Read-only Data type: Variant |
| MSMQOutgoingQueueManagement.State | Returns the connection state of the outgoing queue. Run-time access: Read-only Data type: Long |
Elements of MSMQCollection Objects
The MSMQOutgoingQueueManagement.EodGetSendInfo method of the MSMQOutgoingQueueManagement object returns the following elements in an MSMQCollection object.
| Element | Description |
|---|---|
| EodFirstNonAck | An inner collection that contains sequence information about the first transactional message sent for which an order acknowledgment has not been received. Run-time access: Read-only Data type: MSMQCollection |
| EodLastAck | An inner collection that contains sequence information about the last transactional message sent for which an order acknowledgment has been received. Run-time access: Read-only Data type: MSMQCollection |
| EodLastAckCount | The number of times that the last order acknowledgment was received. Run-time access: Read-only Data type: Long |
| EodLastAckTime | The date and time when the last order acknowledgment for a message sent from the computer to the queue was received. Run-time access: Read-only Data type: Long |
| EodLastNonAck | An inner collection that contains sequence information about the last transactional message sent for which an order acknowledgment has not been received. Run-time access: Read-only Data type: MSMQCollection |
| EodNextSeq | An inner collection that contains sequence information about the next message to be sent. Run-time access: Read-only Data type: MSMQCollection |
| EodNoAckCount | The number of messages sent for which an order acknowledgment has not been received. Run-time access: Read-only Data type: Long |
| EodNoReadCount | The number of messages sent for which an order acknowledgment has been received but a receive acknowledgment has not been received. Run-time access: Read-only Data type: Long |
| EodResendCount | The number of times that the last message was sent. Run-time access: Read-only Data type: Long |
| EodResendInterval | The time interval for resending the messages in the outgoing queue for which no order acknowledgment has been received. Run-time access: Read-only Data type: Long |
| EodResendTime | The time when the next messages will be resent from the outgoing queue. Run-time access: Read-only Data type: Long |
Requirements
Windows NT/2000/XP: Included in Windows XP and Windows Server 2003.
Windows 95/98/Me: Unsupported.
Header: Declared in Mqoai.h.
Library: Use Mqoa.lib.