3.11.4.1 IMSMQQueue4 Interface
The IMSMQQueue4 interface provides methods that provide interaction with a queue on a given server. The version number for this interface is 1.0.
There are three previous versions of this interface: IMSMQQueue, IMSMQQueue2, and IMSMQQueue3. These previous versions are nearly identical but have somewhat fewer methods. All differences from previous versions are described in Windows Behavior notes in the method descriptions that follow.
To receive incoming remote calls for this interface, the server MUST implement a DCOM object class with the CLSID {d7d6e079-dccd-11d0-aa4b-0060970debae} (coclass MSMQQueue, as specified in section 1.9), which implements the IMSMQQueue4 interface using the UUID {eba96b20-2168-11d3-898c-00e02c074f6b}.
The following opnum table begins at opnum 7. Opnums 0 through 2 are inherited from the IUnknown interface, as specified in [MS-DCOM] section 3.1.1.5.8. Opnums 3 through 6 are inherited from the IDispatch interface, as specified in [MS-OAUT] section 3.1.4.
Methods in RPC Opnum Order
|
Method |
Description |
|---|---|
|
Returns the access mode in which the queue was opened. Opnum: 7 |
|
|
Returns the share mode in which the queue was opened. Opnum: 8 |
|
|
Returns an MSMQQueueInfo object that contains the initial settings that were used to open the queue.<47> Opnum: 9 |
|
|
Returns the open queue's handle. Opnum: 10 |
|
|
Returns a value indicating whether the queue is open. Opnum: 11 |
|
|
Closes the open queue. Opnum: 12 |
|
|
Retrieves the message at the head of the queue and removes it from the queue. Opnum: 13 |
|
|
Retrieves the message at the head of the queue without removing it. Opnum: 14 |
|
|
Starts event notification for asynchronously reading messages in the queue. Opnum: 15 |
|
|
Resets the cursor position to the head of the queue. Opnum: 16 |
|
|
Retrieves the message at the current cursor position and removes it from the queue. Opnum: 17 |
|
|
Advances the cursor to the next message in the queue and retrieves it without removing it. Opnum: 18 |
|
|
Retrieves the message at the current cursor position without removing it. Opnum: 19 |
|
|
Retrieves the message at the head of the queue and removes it from the queue.<48><49> Opnum: 20 |
|
|
Retrieves the message at the head of the queue without removing it.<50><51> Opnum: 21 |
|
|
Retrieves the message at the current cursor position and removes it from the queue.<52><53> Opnum: 22 |
|
|
Advances the cursor to the next message in the queue and retrieves it without removing it.<54> Opnum: 23 |
|
|
Retrieves the message at the current cursor position without removing it.<55><56> Opnum: 24 |
|
|
This method is not implemented.<57> Opnum: 25 |
|
|
Returns the handle of the open queue.<58> Opnum: 26 |
|
|
Retrieves the message with a lookup identifier that is equal to the specified lookup ID and removes it from the queue.<59><60> Opnum: 27 |
|
|
Retrieves the message that follows a message with a lookup identifier equal to the specified lookup ID and removes it from the queue.<61><62> Opnum: 28 |
|
|
Retrieves the message that precedes a message with a lookup identifier equal to the specified lookup ID and removes it from the queue.<63><64> Opnum: 29 |
|
|
Retrieves the message at the head of the queue and removes it from the queue.<65><66> Opnum: 30 |
|
|
Retrieves the message at the tail of the queue and removes it from the queue.<67><68> Opnum: 31 |
|
|
Retrieves the message with a lookup identifier that equals the specified lookup ID without removing it.<69><70> Opnum: 32 |
|
|
Retrieves the message that follows a message with a lookup identifier that equals the specified lookup ID without removing it.<71><72> Opnum: 33 |
|
|
Retrieves the message that precedes a message with a lookup identifier that equals the specified lookup ID without removing it.<73><74> Opnum: 34 |
|
|
Retrieves the message at the head of the queue without removing it.<75><76> Opnum: 35 |
|
|
Retrieves the message at the tail of the queue without removing it.<77><78> Opnum: 36 |
|
|
Deletes all the messages in the queue.<79> Opnum: 37 |
|
|
Returns a value indicating whether the queue is open.<80> Opnum: 38 |
|
|
Retrieves the message with a lookup identifier that equals the specified lookup ID and removes it from the queue.<81> Opnum: 39 |