3.1.4.2.64 ApiReAddNotifyGroup (Opnum 63)

(Protocol Version 3) The ApiReAddNotifyGroup method instructs the server to begin queuing event indications. Event indications correspond to internal cluster group 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 group 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 queue a CLUSTER_CHANGE_GROUP_STATE event indication to the port if the dwStateSequence parameter is not equal to the internal state sequence of the group.

The server SHOULD accept an ApiReAddNotifyGroup 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 ApiReAddNotifyGroup request if the access level associated with the hGroup context handle is at least "Read" (section 3.1.4).

 error_status_t ApiReAddNotifyGroup(
   [in] HNOTIFY_RPC hNotify,
   [in] HGROUP_RPC hGroup,
   [in] DWORD dwFilter,
   [in] DWORD dwNotifyKey,
   [in] DWORD StateSequence,
   [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.

hGroup: An HGROUP_RPC (section 2.2.1.3) context handle that was obtained in a previous ApiOpenGroup (section 3.1.4.2.42), ApiOpenGroupEx (section 3.1.4.2.118), or ApiCreateGroup (section 3.1.4.2.43) method call.

dwFilter: A 32-bit integer containing one or more group-specific values in a CLUSTER_CHANGE enumeration. The value of this parameter MUST be set to the bitwise OR operator of one or more of the following values: CLUSTER_CHANGE_GROUP_ADD, CLUSTER_CHANGE_GROUP_DELETE, CLUSTER_CHANGE_GROUP_STATE, and CLUSTER_CHANGE_GROUP_PROPERTY.

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 hGroup (the second parameter).

dwStateSequence: A 32-bit integer value that was obtained from a call to the ApiAddNotifyGroup (section 3.1.4.2.60) method or from the most recent value obtained from subsequent calls to ApiGetNotify (section 3.1.4.2.66).

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether the runtime 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 hGroup parameter does not respectively represent a valid HNOTIFY_RPC (section 2.2.1.6) or HGROUP_RPC (section 2.2.1.3) 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.