CLUSCTL_COLLECTION_GET_GROUPS control code

Retrieves a list of the groups in the collection.

Applications use this control code as a ClusterGroupCollectionControl parameter.

ClusterGroupCollectionControl( 
  hCollection,                            // collection handle
  hHostNode,                              // optional node handle
  CLUSCTL_COLLECTION_GET_GROUPS,          // this control code
  NULL,                                   // input buffer (not used)
  0,                                      // input buffer size (not used)
  lpOutBuffer,                            // output buffer: property list
  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 ClusterGroupCollectionControl.

lpOutBuffer

On a successful return, points to a property list containing the groups in the specified collection.

Return value

ClusterGroupCollectionControl returns one of the following values.

ERROR_SUCCESS

0

The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. This value is returned if 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, the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

For information on working with property lists, see Using Property Lists.

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_GROUPSET (0x7)
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_COLLECTION_GET_GROUPS (0x2D72)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Header	ClusAPI.h

See also

Collection Control Codes

ClusterGroupCollectionControl