CLUSCTL_GROUP_GET_NAME control code

Retrieves the name of a group. Applications use this control code as a ClusterGroupControl parameter.

ClusterGroupControl( 
  hGroup,                  // group handle
  hHostNode,               // optional node handle
  CLUSCTL_GROUP_GET_NAME,  // this control code
  NULL,                    // input buffer (not used)
  0,                       // input buffer size (not used)
  lpOutBuffer,             // output buffer: string
  cbOutBufferSize,         // output buffer size (bytes)
  lpcbBytesReturned        // resulting data size (bytes)
);

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterGroupControl.

lpOutBuffer

On a successful return, points to a NULL-terminated Unicode string containing the name of the group.

Return value

ClusterGroupControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

The name of a group is stored in the Name property. To retrieve the Name property along with the other read-only common group properties, use the CLUSCTL_GROUP_GET_RO_COMMON_PROPERTIES control code.

Do not use any group control codes in any resource DLL entry point function. Group control codes can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

ClusAPI.h defines the 32 bits of CLUSCTL_GROUP_GET_NAME as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_GROUP (0x3)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_NO_MODIFY (0x0)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_GET_NAME (0x29)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	ClusAPI.h

See also

Group Control Codes

CLUSCTL_GROUP_GET_RO_COMMON_PROPERTIES

ClusterGroupControl

Name