Share via

3.10.4.1.21 Authenticate (Opnum 27)

  • Article

The Authenticate method is received by the server in an RPC_REQUEST packet. In response, the server returns the authentication level for the referenced queue.

 [propget] HRESULT Authenticate(
   [out, retval] long* plAuthenticate
 );

plAuthenticate: A pointer to a long that corresponds to one of the MQAUTHENTICATE (section 2.2.2.6) enumeration values.

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

When processing this call, the server MUST abide by the following contract:

  • If IsRefreshed is FALSE call Refresh (section 3.10.4.1.29).

  • If Refresh returns a value other than S_OK (0x00000000), return the HRESULT returned by Refresh and take no further action.

  •  If IsApplicationQueue is True and refQueue.Authentication equals True:

    •  Set the plAuthenticate output parameter to MQ_AUTHENTICATE (0x00000001).

  •  Else:

    •  Set the plAuthenticate output parameter to MQ_AUTHENTICATE_NONE (0x00000000).

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