MSMQCollection

  • 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

(Introduced in MSMQ 3.0.) The MSMQCollection object represents a collection of Variant elements. It can be used to obtain sets of properties that correspond to the internal state of a queue.

The elements contained in each MSMQCollection object and the sets of properties that they describe are set internally by Message Queuing and depend on the source of the object. The following three types of MSMQCollection objects are created by Message Queuing:

  • MSMQCollection objects that are returned by the MSMQOutgoingQueueManagement.EodGetSendInfo method.

    These collection objects contain 11 exactly-once-delivery (EOD) information elements. Seven of these elements contain property values for the message stream sent from the outgoing queue. Four are inner MSMQCollection objects that contain property values for specific messages in the message stream:

  • MSMQCollection objects that are elements in the array of MSMQCollection objects returned by the MSMQQueueManagement.EodGetReceiveInfo method.

    Each MSMQCollection object in the array represents a source computer and contains six elements:

  • MSMQCollection objects that are elements of an MSMQCollection object returned by the MSMQOutgoingQueueManagement.EodGetSendInfo method.

    The inner collection in these elements contains three elements that describe specific messages.

Methods

The MSMQCollection object defines the following method.

Method Description
MSMQCollection.Item (Introduced in MSMQ 3.0.) Obtains a specified element from the collection.

Properties

The MSMQCollection object defines the following property.

Property Description
MSMQCollection.Count (Introduced in MSMQ 3.0.) Returns the number of elements in the collection.

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

See Also

Message Queuing COM Components
MSMQOutgoingQueueManagement.EodGetSendInfo
MSMQQueueManagement.EodGetReceiveInfo