GetClusterInformation

The GetClusterInformation function retrieves a cluster's name and version.

DWORD WINAPI GetClusterInformation(
  HCLUSTER hCluster,                  
  LPWSTR lpszClusterName,             
  LPDWORD lpcchClusterName,           
  LPCLUSTERVERSIONINFO lpClusterInfo  
);
 

Parameters

hCluster

[in] Handle to a cluster.

lpszClusterName

[out] Pointer to the name of the cluster identified by hCluster, including the terminating NULL character.

lpcchClusterName

[in, out] On input, pointer to a buffer. On output, pointer to a count of characters in the cluster name pointed to by lpszClusterName, including the terminating NULL character.

lpClusterInfo

[out] Either NULL or a pointer to a CLUSTERVERSIONINFO structure describing the version of the Cluster API for the cluster. When lpClusterInfo is not NULL, the dwVersionInfoSize member of this structure should be set as follows:

lpClusterInfo->dwVersionInfoSize = 
sizeof(CLUSTERVERSIONINFO);

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_MORE_DATA

The buffer pointed to by lpszClusterName is not long enough to hold the required number of characters. The lpcchClusterName parameter is set to the required buffer length.

If the operation was unsuccessful for a reason other than insufficient size in the buffer pointed to by lpszClusterName, GetClusterInformation returns a Win32 error value.

Remarks

When GetClusterInformation returns, the variable pointed to by lpcchClusterName contains the number of characters stored in the buffer. The count returned does not include the terminating NULL character.

QuickInfo

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