MSMQOutgoingQueueManagement.State

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 State property of the MSMQOutgoingQueueManagement object identifies the connection status of the outgoing queue.

Property State
() As Long  

Property Value

The State property can have any one of the following values:

MQ_QUEUE_STATE_CONNECTED

The applicable outgoing queue is connected to the queue manager on the computer. This state indicates the local queue manager is sending messages and that the messages should be going out.

MQ_QUEUE_STATE_DISCONNECTED

The applicable outgoing queue is not connected nor is it in the process of being connected. The queue manager cannot send messages to the destination queue in this state.

MQ_QUEUE_STATE_DISCONNECTING

The queue manager on the computer is in the process of disconnecting the applicable outgoing queue or the computer is in the process of disconnecting from the applicable session. The queue manager cannot send messages to the destination queue in this state.

MQ_QUEUE_STATE_INACTIVE

The applicable outgoing queue is in a state in which the queue manager does not attempt to connect it to any session.

MQ_QUEUE_STATE_LOCAL_CONNECTION

The queue is a local queue or connector queue on the computer. This state indicates that a network connection is not needed to send messages to or receive messages from the queue.

MQ_QUEUE_STATE_LOCKED

The applicable outgoing queue is in the state defined by hardened MSMQ mode for outgoing queues that correspond to destination queues specified by non-HTTP format names. Messages in locked outgoing queues are not transmitted to their destinations.

MQ_QUEUE_STATE_NEEDVALIDATE

The queue was opened when the queue manager was offline.

MQ_QUEUE_STATE_ONHOLD

The applicable outgoing queue is paused. The MSMQOutgoingQueueManagement.Pause method brings an outgoing queue into this state.

MQ_QUEUE_STATE_WAITING

The applicable outgoing queue is in the process of being connected.

Remarks

Equivalent API Function Property

When using API functions, the equivalent property is PROPID_MGMT_QUEUE_STATE.

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.

See Also

MSMQOutgoingQueueManagement
MSMQOutgoingQueueManagement.Pause