3.1.4.2.136 ApiCreateNotifyV2 (Opnum 137)
(Protocol Version 3) The ApiCreateNotifyV2 method uses the current RPC connection to establish a context on the server about the interaction of a client with a cluster version 2 notification port.
Upon receipt of this method, the server MUST create and maintain a queuing mechanism for posting event indications to the notification port, as specified in section 3.1.1.8. This mechanism is maintained using implementation-specific methods and protocols between servers.
The server MUST NOT queue any event indications to the port until the first event filter has been registered, as specified in ApiAddNotifyV2 (section 3.1.4.2.137).
When calling theApiAddNotifyV2 (section 3.1.4.2.137), ApiGetNotifyV2 (section 3.1.4.2.138), ApiCloseNotify (section 3.1.4.2.57), and ApiUnblockGetNotifyCall (section 3.1.4.2.107) methods, the client MUST use the HNOTIFY_RPC handle obtained by calling this method.
The server SHOULD accept an ApiCreateNotifyV2 request if its protocol server state is read-only. The server MUST accept an ApiCreateNotifyV2 request if it is in the read/write state, as specified in section 3.1.1.
The server SHOULD accept an ApiCreateNotifyV2 request if the client's access level is at least "Read" (section 3.1.4).
-
HNOTIFY_RPC ApiCreateNotifyV2( [out] error_status_t *rpc_error, [out] error_status_t *rpc_status );
rpc_error: Indicates the status of the operation. The server MUST set this parameter to the value ERROR_SUCCESS (0x00000000) on success, or to one of the values specified in ApiCreateNotify (section 3.1.4.2.56) for other conditions. Clients MUST treat all values the same except as specified in section 3.2.4.6.
rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether it succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for comm_status and fault_status, as specified in Appendix E of [C706].
Return Values: The method MUST return a valid HNOTIFY_RPC context handle, as specified in section 2.2.1.6, to indicate success. Otherwise, it MUST return NULL.