CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS control code
Retrieves the collections that come from providers by specifying a group.
Applications use this control code as a ClusterGroupCollectionControl parameter.
ClusterGroupCollectionControl(
hGroup, // group handle
hHostNode, // optional node handle
CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS, // 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 collections in the that come from a provider.
Return value
ClusterGroupCollectionControl returns one of the following values.
-
ERROR_SUCCESS
-
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.
-
The operation was not successful. If the operation required an output buffer, the value specified by lpBytesReturned (if not NULL on input) is unreliable.
Remarks
For information on working with property lists, see Using Property Lists.
ClusAPI.h defines the 32 bits of CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS as follows (for more information, see Control Code Architecture).
| Component | Bit location | Value |
|---|---|---|
| Object code | 24 31 | CLUS_OBJECT_COLLECTION (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_GROUP_GET_PROVIDER_COLLECTIONS (0x2D7A) |
| Access code | 0 1 | CLUS_ACCESS_READ (0x1) |
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Header |
|