3.1.4.2.62 ApiAddNotifyKey (Opnum 61)

(Protocol Version 3) The ApiAddNotifyKey method instructs the server to begin queuing event indications. Event indications correspond to internal cluster registry state and configuration changes that map to a value in the designated filter of the designated version 1 notification port. Indications are queued for the cluster registry key represented by the designated context handle.

The server MUST queue a separate event indication to the port for every filter that has the CLUSTER_CHANGE (section 2.2.2.7) value set (section 2.2.2.7) that corresponds to the internal event.

The server MUST monitor the designated key for changes in the key, its security descriptor, or any of its values, and post the corresponding CLUSTER_CHANGE event indication. If the WatchSubTree parameter is set to TRUE, the server MUST extend the scope of monitoring to all subkeys and to their security descriptors and values under the designated key, and post individual event indications for each detected change.

The server SHOULD accept an ApiAddNotifyKey request if its protocol server state is read-only and MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.

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

 error_status_t ApiAddNotifyKey(
   [in] HNOTIFY_RPC hNotify,
   [in] HKEY_RPC hKey,
   [in] DWORD dwNotifyKey,
   [in] DWORD Filter,
   [in] BOOL WatchSubTree,
   [out] error_status_t *rpc_status
 );

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.

hKey: An HKEY_RPC (section 2.2.1.5) context handle that was obtained in a previous ApiGetRootKey (section 3.1.4.2.29), ApiCreateKey (section 3.1.4.2.30) or ApiOpenKey (section 3.1.4.2.31) method call that indicates the key in the cluster registry that is monitored for changes.

dwNotifyKey: A 32-bit integer context value chosen by the client. This value MUST be returned to the client via a subsequent completion of the ApiGetNotify (section 3.1.4.2.66) method, if the name of the object pertaining to the event matches the name of the object designated by hKey (the second parameter).

Filter: A 32-bit integer containing one or more registry-specific values in a CLUSTER_CHANGE (section 2.2.2.7) enumeration. The value of this parameter MUST be set to the bitwise OR operator of one or more of the following values: CLUSTER_CHANGE_REGISTRY_NAME, CLUSTER_CHANGE_REGISTRY_ATTRIBUTES, or CLUSTER_CHANGE_REGISTRY_VALUE.

WatchSubTree: A Boolean value where TRUE indicates that a change in any subkeys and/or values under the specified cluster registry key will cause event indications to be queued when a change corresponding to the appropriate filter has been detected.

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 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 or the hKey parameter does not respectively represent a valid HNOTIFY_RPC (section 2.2.1.6) or HKEY_RPC (section 2.2.1.5) 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.