GetClusterNotify

The GetClusterNotify function returns information relating to the next notification event stored for a notification port.

DWORD WINAPI GetClusterNotify(
  HCHANGE hChange,        
  LPDWORD lpdwNotifyKey,  
  LPDWORD lpdwFilterType,  
  LPWSTR lpszName,        
  LPDWORD lpcchName,      
  DWORD dwMilliseconds    
);
 

Parameters

hChange

[in] Handle to a notification port created with the CreateClusterNotifyPort function.

lpdwNotifyKey

[out] Pointer to the notification key for the port identified by hChange.

lpdwFilterType

[out] Pointer to the type of returned event. See CreateClusterNotifyPort for the list of valid event types.

lpszName

[out] Pointer to the name of the object that triggered the event. The following table describes the contents of lpszName by event type. Note that CLUSTER_CHANGE_REGISTRY_SUBTREE is not included in the table; this event type is never handled by GetClusterNotify.

Value of lpdwFilterType	Value of lpszName
CLUSTER_CHANGE_GROUP_ADDED	New group name.
CLUSTER_CHANGE_GROUP_DELETED	Deleted group name.
CLUSTER_CHANGE_GROUP_PROPERTY	Name of changed group.
CLUSTER_CHANGE_GROUP_STATE	Name of changed group.
CLUSTER_CHANGE_HANDLE_CLOSE	Name of object being closed.
CLUSTER_CHANGE_NODE_ADDED	Name of new node.
CLUSTER_CHANGE_NODE_DELETED	Name of deleted node.
CLUSTER_CHANGE_NODE_PROPERTY	Name of changed node.
CLUSTER_CHANGE_NODE_STATE	Name of changed node.
CLUSTER_CHANGE_REGISTRY_ ATTRIBUTES	Relative name of changed cluster database key.
CLUSTER_CHANGE_REGISTRY_NAME	Relative name of changed cluster database key.
CLUSTER_CHANGE_REGISTRY_VALUE	Relative name of changed cluster database key.
CLUSTER_CHANGE_RESOURCE_ADDED	New resource name.
CLUSTER_CHANGE_RESOURCE_ DELETED	Deleted resource name.
CLUSTER_CHANGE_RESOURCE_ PROPERTY	Name of changed resource.
CLUSTER_CHANGE_RESOURCE_STATE	Name of changed resource.
CLUSTER_CHANGE_RESOURCE_ TYPE_ADDED	Name of new resource type.
CLUSTER_CHANGE_RESOURCE_ TYPE_DELETED	Name of deleted resource type.

lpcchName

[in, out] On input, pointer to the count of characters in the buffer pointed to by lpszName. On output, pointer to the count of characters stored in the buffer pointed to by lpszName, excluding the trailing NULL.

dwMilliseconds

[in] Optional time-out value that specifies how long the caller is willing to wait for the notification.

Return Values

ERROR_SUCCESS

The notification was successfully returned.

ERROR_INVALID_HANDLE

The handle represented in the hChange parameter is invalid or has been closed by another thread.

WAIT_TIMEOUT

The call timed out before the notification could be successfully returned.

If the notification was not successfully returned, GetClusterNotify returns a Win32 error value. For more detailed information about the error, call the Win32 function GetLastError.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.