3.15.4.1.1 Item (Opnum 7)

  • Article

The Item method is received by the server in an RPC_REQUEST packet. In response, the server MUST return a VARIANT from the VariantCollection instance variable where the key matches the Index input parameter.

 HRESULT Item(
   [in] VARIANT* Index,
   [out, retval] VARIANT* pvarRet
 );

Index: A pointer to a VARIANT containing a BSTR that contains the key value used to look up the associated VARIANT value in the VariantCollection instance variable.

pvarRet: A pointer to a VARIANT that upon success will contain the element returned from the VariantCollection instance variable.

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 VariantCollection instance variable does not contain an element where the key value matches the Index input parameter:

    • The server MUST return MQ_ERROR_INVALID_PARAMETER (0xC00E0006) and take no further action.

  • The pvarRet output parameter MUST be set to the associated VARIANT in the VariantCollection instance variable where the key value matches the Index input parameter.