PROPID_MGMT_QUEUE_BYTES_IN_QUEUE

  • Article

 

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_BYTES_IN_QUEUE property returns the number of message bytes in the queue.

Property ID

PROPID_MGMT_QUEUE_BYTES_IN_QUEUE

Type Indicator

VT_UI4

MQPROPVARIANT Field

ulVal

Property Value

Number of message bytes in the queue.

Remarks

To retrieve the number of message bytes in the queue, include PROPID_MGMT_QUEUE_BYTES_IN_QUEUE 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 message bytes in a queue that does not contain messages and is not opened by an application.

The quota, or the maximum number of bytes that can be stored in the queue, is set by the PROPID_Q_QUOTA property of the queue.

Equivalent COM Property

When using COM components, you can retrieve the number of message bytes in a queue using the MSMQManagement.BytesInQueue property.

Example Code

The following code fragment shows how PROPID_MGMT_QUEUE_BYTES_IN_QUEUE is specified in arrays that can be used to initialize an MQMGMTPROPS structure.

aMgmtPropID[i] = PROPID_MGMT_QUEUE_BYTES_IN_QUEUE;    // Property identifier  
aMgmtPropVar[i].vt = VT_NULL;                         // Type indicator  
i++;

See Also

Management Properties
MQMgmtGetInfo
MSMQManagement.BytesInQueue