IGetClusterDataInfo::GetClusterName

The IGetClusterDataInfo::GetClusterName method retrieves the name of the current cluster.

HRESULT GetClusterName(
  BSTR lpszName,  
  LONG *pcchName 
);
 

Parameters

lpszName

[out] Pointer to the name of the cluster, or NULL, indicating that the caller is requesting only the length of the name.

pcchName

[in, out] On input, pointer to the count of characters in the buffer pointed to by the lpszName parameter. On output, pointer to the total number of characters in the buffer including the terminating null character.

Return Values

NOERROR

The operation was successful.

E_INVALIDARG

One or more of the parameters are invalid.

ERROR_MORE_DATA

The buffer pointed to by lpszName is too small to hold the requested name. GetClusterName returns the required number of characters in the contents of pcchName.

If GetClusterName is unsuccessful, it can also return an OLE-defined error value.

Remarks

If the lpszName parameter is set to NULL and the pcchName parameter is not set to NULL, GetClusterName returns NOERROR.

QuickInfo

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