Share via

3.11.4.1.11 ReceiveCurrent_v1 (Opnum 17)

  • Article

The ReceiveCurrent_v1 method is received by the server in an RPC_REQUEST packet. In response, the server retrieves the Message at the current cursor position in the referenced queue's MessagePositionList, removes it, and advances the cursor.

 HRESULT ReceiveCurrent_v1(
   [in, optional] VARIANT* Transaction,
   [in, optional] VARIANT* WantDestinationQueue,
   [in, optional] VARIANT* WantBody,
   [in, optional] VARIANT* ReceiveTimeout,
   [out, retval] IMSMQMessage** ppmsg
 );

Transaction: A pointer to a VARIANT that MUST contain either:

  • A VT_DISPATCH or a VT_DISPATCH | VT_BYREF that points to an MSMQTransaction object.

  • A VT_I4 that corresponds to one of the MQTRANSACTION (section 2.2.2.1) enumeration values.

    If this parameter is not specified by the client, the server MUST use the default value MQ_MTS_TRANSACTION (0x00000001) in place of the unspecified value.

WantDestinationQueue: A pointer to a VARIANT (VT_BOOL).

If this parameter is not specified by the client, the server MUST use the default value VARIANT_FALSE (0x0000) in place of the unspecified value.

Value

Meaning

VARIANT_TRUE

0xFFFF

The server MUST return an MSMQMessage object that has the DestinationQueueInfo property set.

VARIANT_FALSE

0x0000

Default. The server MUST return an MSMQMessage object that does not have the DestinationQueueInfo property set.

WantBody: A pointer to a VARIANT (VT_BOOL).

If this parameter is not specified by the client, the server MUST use the default value VARIANT_TRUE (0xFFFF) in place of the unspecified value.

Value

Meaning

VARIANT_TRUE

0xFFFF

Default. The server MUST return an MSMQMessage object that has the Body property set.

VARIANT_FALSE

0x0000

The server MUST return an MSMQMessage object that does not have the Body property set.

ReceiveTimeout: A pointer to a VARIANT containing a long value (VT_I4) that specifies the time, in milliseconds, that the server MUST NOT exceed while waiting for a new message to arrive.

If this parameter is not specified by the client, the server MUST use the default value INFINITE (0xFFFFFFFF).

ppmsg: A pointer to a pointer to an IMSMQMessage interface that MUST be set by the server with the received message.

Return Values: The method MUST return S_OK (0x00000000) on success or an implementation-specific error HRESULT on failure.

When processing this call, the server MUST follow these guidelines:

  • If the IsInitialized instance variable equals False:

    • Return an error OLE_E_BLANK (0x80040007), and take no further action.

  • If the IsClosed instance variable equals True:

    • Return an error MQ_ERROR_INVALID_HANDLE (0xC00E0007), and take no further action.

  • If refQueue.AccessType is not equal to ReceiveAccess or ReceiveAdminAccess:

    • Return an error MQ_ERROR_ACCESS_DENIED (0xC00E0025), and take no further action.

  • If the ppmsg output parameter is NULL:

    • Return E_INVALIDARG (0x80070057), and take no further action.

  • If the Transaction input parameter is not NULL:

    • If the Transaction input parameter is a VT_DISPATCH or a VT_DISPATCH | VT_BYREF that points to an MSMQTransaction object:

      • Obtain the MSMQTransaction instance that corresponds to the Transaction parameter by invoking the IDispatch::QueryInterface method (see section 3.1) on the Transaction parameter with the interface identifier of IMSMQTransaction3.

      • Define transaction identifier as MSMQTransaction.Transaction.TransactionIdentifier.

    • Else, if the Transaction input parameter is a VT_I4:

      • Define and retrieve transaction identifier as described in section 2.2.2.1, using the enum numeric value represented by the Transaction input parameter.

    • Else:

      • Return an error, and take no further action.

    • Identify the Transaction from the QueueManager.TransactionCollection, where the value of the Transaction.Identifier property equals the value of the transaction identifier.

    • If a Transaction cannot be located in the QueueManager.TransactionCollection:

      • Create a new Transaction object, and set the Transaction.Identifier property to the value of the transaction identifier. Refer to this Transaction object as the identified Transaction object in the QueueManager.TransactionCollection henceforth.

      • Add the created Transaction object to the QueueManager.TransactionCollection.

  • If the message represented by the Cursor instance variable is in the MessageDeleted state:

    • Set the ppmsg output parameter to NULL.

    • Return an error MQ_ERROR_MESSAGE_ALREADY_RECEIVED (0xc00e001d), and take no further action.

  • Define suitable message as a Message, identified by the cursor represented by the Cursor instance variable, in the MessagePositionList of the referenced queue for which the MessagePosition.State attribute does not equal Locked.

  • Starting from the Message identified by the cursor represented by the Cursor instance variable, continually advance the cursor, seeking a suitable message. If the cursor reaches the EndQueue state, wait for more messages to arrive. Do this by raising the Dequeue Message event with the following arguments:

    • iQueueDesc: This MUST be set to the OpenQueueDescriptor at Cursor.OpenQueueDescriptorReference.

    • iTimeout: The amount of time to wait in seconds.

    • iCursor: This MUST be set to a reference to the Cursor instance variable.

    • iTransaction: If the Transaction input parameter is not NULL, this MUST be set to a reference to the newly created Transaction object that provides the unit-of-work for the dequeue operation.

  • Based on the rStatus, take the following actions:

    • If the rStatus is not MQ_OK and the ReceiveTimeout input parameter equals 0:

      • Set the ppmsg output parameter to NULL.

      • Return an error MQ_ERROR_MESSAGE_NOT_FOUND (0xc00e0008), and take no further action.

    • If rStatus is MQ_ERROR_IO_TIMEOUT, and the ReceiveTimeout input parameter is greater than 0 and is not equal to INFINITE, and the time-out identified by the ReceiveTimeout input parameter expires:

      • Set the ppmsg output parameter to NULL.

      • Return an error MQ_ERROR_IO_TIMEOUT (0xc00e001b), and take no further action.

  • If the rStatus is MQ_OK:

    • Retrieve the suitable message, and instantiate an MSMQMessage instance and initialize it with the suitable message, observing the requirements set forth by the WantBody and WantDestinationQueue input parameters. For details of initializing the MSMQMessage object, refer to section 3.17.3.

    • Set the ppmsg output parameter to the newly instantiated MSMQMessage instance.

    • Advance the cursor represented by the Cursor instance variable.

    • If the Transaction input parameter is equal to MQ_MTS_TRANSACTION (0x00000001), MQ_XA_TRANSACTION (0x00000002), or a pointer to an enlisted MSMQTransaction instance:

      • Set the State property of the suitable message to Locked.

      • Create a new TransactionalOperation, and set:

        • The MessageReference property with the suitable message.

        • The OperationType property to the OperationType.Receive enumeration value.

      • Add the newly created TransactionalOperation to the Transaction.TransactionalOperationCollection previously identified.

    • Else:

      • If QueueType is NOT set to System for the referenced queue, and its Journaling property is True:

        • Copy the suitable message to the MessagePositionList of the queue referenced by the JournalQueueReference property of the referenced queue.

      • Remove the suitable message from the MessagePositionList of the referenced queue.

  • Return S_OK (0x00000000), and take no further action.