ClusterRegGetBatchNotification function

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 WINAPI ClusterRegGetBatchNotification(
  _In_  HREGBATCHPORT         hBatchNotify,
  _Out_ HREGBATCHNOTIFICATION *phBatchNotification
);

Parameters

hBatchNotify [in]

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

phBatchNotification [out]

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.

ERROR_SUCCESS

0

The operation was successful.

ERROR_INVALID_DATA

13 (0xD)

The data is not valid.

ERROR_OUTOFMEMORY

14 (0xE)

Not enough storage is available to complete this operation.

ERROR_GEN_FAILURE

31 (0x1F)

A device attached to the system is not functioning.

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 Datacenter, Windows Server 2008 Enterprise

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Cluster Registry Access Functions
ClusterRegBatchReadCommand
ClusterRegBatchCloseNotification
ClusterRegCreateBatchNotifyPort

 

 

Show: