PROPID_MGMT_QUEUE_MESSAGE_COUNT
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
(Read-only, introduced in MSMQ 3.0.) The PROPID_MGMT_QUEUE_MESSAGE_COUNT property returns the number of messages in the queue.
Property ID
PROPID_MGMT_QUEUE_MESSAGE_COUNT
Type Indicator
VT_UI4
MQPROPVARIANT Field
ulVal
Property Value
Number of messages in the queue.
Remarks
To retrieve the number of messages in the queue, include PROPID_MGMT_QUEUE_MESSAGE_COUNT T in the MQMGMTPROPS structure, call MQMgmtGetInfo, and then examine the value returned.
This property can be retrieved only for an active queue. MQMgmtGetInfo will return a non-specific error (MQ_ERROR) if your application attempts to retrieve the number of messages in a queue that does not contain messages and is not opened by an application.
Equivalent COM Property
When using COM components, you can determine the number of messages in a queue using the MSMQManagement.MessageCount property.
Example Code
The following code fragment shows how PROPID_MGMT_QUEUE_MESSAGE_COUNT is specified in arrays that can be used to initialize an MQMGMTPROPS structure.
aMgmtPropID[i] = PROPID_MGMT_QUEUE_MESSAGE_COUNT; // Property identifier
aMgmtPropVar[i].vt = VT_NULL; // Type indicator
i++;
See Also
Management Properties
MQMgmtGetInfo
MSMQManagement.MessageCount