Skip to content

Latest commit

 

History

History
156 lines (126 loc) · 4.43 KB

nf-clusapi-clusterreggetbatchnotification.md

File metadata and controls

156 lines (126 loc) · 4.43 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:clusapi.ClusterRegGetBatchNotification
ClusterRegGetBatchNotification function (clusapi.h)
Fetches the batch notification.
ClusterRegGetBatchNotification
ClusterRegGetBatchNotification function [Failover Cluster]
PCLUSTER_REG_GET_BATCH_NOTIFICATION
PCLUSTER_REG_GET_BATCH_NOTIFICATION function [Failover Cluster]
clusapi/ClusterRegGetBatchNotification
clusapi/PCLUSTER_REG_GET_BATCH_NOTIFICATION
mscs.clusterreggetbatchnotification
mscs\clusterreggetbatchnotification.htm
MsCS
4cc6925f-cf91-449b-8f9d-fcf48b4df896
12/05/2018
ClusterRegGetBatchNotification, ClusterRegGetBatchNotification function [Failover Cluster], PCLUSTER_REG_GET_BATCH_NOTIFICATION, PCLUSTER_REG_GET_BATCH_NOTIFICATION function [Failover Cluster], clusapi/ClusterRegGetBatchNotification, clusapi/PCLUSTER_REG_GET_BATCH_NOTIFICATION, mscs.clusterreggetbatchnotification
clusapi.h
Windows
None supported
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
ClusAPI.lib
ClusAPI.dll
Windows
19H1
ClusterRegGetBatchNotification
clusapi/ClusterRegGetBatchNotification
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
ClusterRegGetBatchNotification

ClusterRegGetBatchNotification function

-description

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.

-parameters

-param hBatchNotify [in]

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

-param 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.

-returns

The function returns one of the following system error codes.

Return code/value Description
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.

-see-also

Cluster Registry Access Functions

ClusterRegBatchCloseNotification

ClusterRegBatchReadCommand

ClusterRegCreateBatchNotifyPort