3.1.4.2.107 ApiUnblockGetNotifyCall (Opnum 107)

  • Article

(Protocol Version 3) The ApiUnblockGetNotifyCall method instructs the server to complete any outstanding ApiGetNotify (section 3.1.4.2.66), ApiGetNotifyV2 (section 3.1.4.2.138), and ApiGetNotifyAsync (section 3.1.4.2.143) calls for the designated notification port so that the port can be closed.

The server SHOULD accept an ApiUnblockGetNotifyCall request if the client's access level is at least "Read" (section 3.1.4).

 error_status_t ApiUnblockGetNotifyCall(
   [in] HNOTIFY_RPC hNotify
 );

hNotify: An HNOTIFY_RPC (section 2.2.1.6) context handle that was obtained in a previous ApiCreateNotify (section 3.1.4.2.56) method call.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x00000006

ERROR_INVALID_HANDLE

The data that is pointed to by the <hNotify> parameter does not respectively represent a valid HNOTIFY_RPC (section 2.2.1.6) context handle.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table. The client SHOULD treat errors specified in section 3.2.4.6 as recoverable errors and initiate the reconnect procedure as specified in section 3.2.4.6.