Edit

Share via

IGetClusterUIInfo::GetClusterName method (cluadmex.h)

  • Article

[This method is available for use in the operating systems specified in the Requirements section. Support for this method was removed in Windows Server 2008.]

Returns the name of the cluster.

Syntax

HRESULT GetClusterName(
  [out]     BSTR lpszName,
  [in, out] LONG *pcchName
);

Parameters

[out] lpszName

Pointer to a null-terminated Unicode string containing the name of the cluster, or NULL to indicate that the caller is requesting only the length of the name. Although declared as a BSTR, this parameter is implemented as an LPWSTR.

[in, out] pcchName

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 NULL-terminating character.

Return value

If GetClusterName is not successful, it can return other HRESULT values.

Return code/value Description
NOERROR
0
 The operation was successful.
E_INVALIDARG
0x80070057
 One or more of the parameters are invalid.
HRESULT_FROM_WIN32(ERROR_MORE_DATA)
0x800700ea
 The buffer pointed to by lpszName is too small to hold the requested name. GetClusterName returns the required number of characters in the content of pcchName.

Remarks

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

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2003 Enterprise, Windows Server 2003 Datacenter
Target Platform Windows
Header cluadmex.h

See also

IGetClusterUIInfo