3.1.4.8 R_QMDeleteObject (Opnum 9)

  • Article

A client calls R_QMDeleteObject to delete a private queue located on the supporting server.

 HRESULT R_QMDeleteObject(
   [in] handle_t hBind,
   [in] struct OBJECT_FORMAT* pObjectFormat
 );

hBind:  MUST be set to an RPC binding handle as described in [MS-RPCE] section 2.

pObjectFormat:  MUST point to an OBJECT_FORMAT structure that identifies an existing local private queue on the supporting server. MUST NOT be NULL. The ObjType member of the structure MUST be 0x00000001. The pQueueFormat member MUST NOT be NULL.

Return Values:  On success, this method MUST return MQ_OK (0x00000000); otherwise, the server MUST return a failure HRESULT,<34><35> and the client MUST treat all failure HRESULTs identically.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol, as specified in [MS-RPCE].

This method is invoked at the dynamically assigned endpoint returned by the R_QMGetRTQMServerPort method when IP_HANDSHAKE (0x00000000) or IPX_HANDSHAKE (0x00000002) is the interface specified by the fIP parameter.

When processing this call, the server MUST:

  • Determine if input parameter values violate the constraints previously specified. If an invalid parameter is detected, the server MUST take no further action and return a failure HRESULT.

  • Locate a Queue ([MS-MQDMPR] section 3.1.1.2) ADM element instance in the QueueCollection attribute of the server's LocalQueueManager ([MS-MQDMPR] section 3.1.1) ADM element instance that is identified by the pObjectFormat parameter.

  • If no entry is resolved, return a failure HRESULT.

  • Generate a Delete Queue ([MS-MQDMPR] section 3.1.7.1.4) event, specifying the Queue ADM element instance located preceding for the iQueue argument.

  • Return the rStatus of the Delete Queue event.