ClusterRegGetBatchNotification function (clusapi.h)

Fetches the batch notification. After the batch notification has been fetched, it is interpreted via the ClusterRegBatchReadCommand function. After the batch notification is processed, it needs to be closed via the ClusterRegBatchCloseNotification function.

Syntax

LONG ClusterRegGetBatchNotification(
  [in]  HREGBATCHPORT         hBatchNotify,
  [out] HREGBATCHNOTIFICATION *phBatchNotification
);

Parameters

[in] hBatchNotify

The handle to the batch notification port opened earlier via the ClusterRegCreateBatchNotifyPort function.

[out] phBatchNotification

A handle to the batch notification that represents all of the changes at or below the cluster registry key of interest that have happened since the last call to ClusterRegGetBatchNotification or since the batch notification port was opened.

Return value

The function returns one of the following system error codes.

Remarks

The PCLUSTER_REG_GET_BATCH_NOTIFICATION type defines a pointer to this function.

Only the functions from the batch function group, such as ClusterRegBatchAddCommand, will generate a registry change notification. A registry change that does not use one of the batch function commands will not generate a batch notification.

Requirements

See also

Cluster Registry Access Functions

ClusterRegBatchCloseNotification

ClusterRegBatchReadCommand

ClusterRegCreateBatchNotifyPort