ClusterRegCreateBatchNotifyPort function (clusapi.h)

Article
10/13/2021

Creates a subscription to a batch notification port. The batch notification port needs to be closed after it is no longer needed. This is done via the ClusterRegCloseBatchNotifyPort function.

Syntax

LONG ClusterRegCreateBatchNotifyPort(
  [in]  HKEY          hKey,
  [out] HREGBATCHPORT *phBatchNotifyPort
);

Parameters

[in] hKey

A cluster registry key. Any updates performed at this key or keys below it will be posted to a notification port.

[out] phBatchNotifyPort

A handle to a batch notification port that allows subsequent reading batch notifications via the ClusterRegGetBatchNotification function.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS (0).

If the operation fails, the function returns a system error code.

Remarks

The PCLUSTER_REG_CREATE_BATCH_NOTIFY_PORT type defines a pointer to this function.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Datacenter, Windows Server 2008 Enterprise
Target Platform	Windows
Header	clusapi.h
Library	ClusAPI.lib
DLL	ClusAPI.dll