ClusterGroupSetControl function (clusapi.h)
Initiates an operation affecting a groupset.
The operation performed depends on the control code passed to the dwControlCode parameter.
Syntax
DWORD ClusterGroupSetControl(
[in] HGROUPSET hGroupSet,
[in, optional] HNODE hHostNode,
[in] DWORD dwControlCode,
[in, optional] LPVOID lpInBuffer,
[in] DWORD cbInBufferSize,
[out, optional] LPVOID lpOutBuffer,
[in] DWORD cbOutBufferSize,
[out, optional] LPDWORD lpBytesReturned
);
Parameters
[in] hGroupSet
Handle to the groupset to be affected.
[in, optional] hHostNode
If non-NULL, handle to the node to perform the operation represented by the control code. If NULL, the node that owns the groupset performs the operation. Specifying hHostNode is optional.
[in] dwControlCode
A Collection Control Code specifying
the operation to be performed. For the syntax associated with a control code, refer to
Control Code Architecture and the following
topics.
- CLUSCTL_GROUPSET_GET_COMMON_PROPERTIES
- CLUSCTL_GROUPSET_GET_GROUPS
- CLUSCTL_GROUPSET_GET_PROVIDER_GROUPS
- CLUSCTL_GROUPSET_GET_PROVIDER_COLLECTIONS
- CLUSCTL_GROUPSET_GET_RO_COMMON_PROPERTIES
- CLUSCTL_GROUPSET_SET_COMMON_PROPERTIES
- CLUSCTL_GROUP_GET_PROVIDER_GROUPS
- CLUSCTL_GROUP_GET_PROVIDER_COLLECTIONS
[in, optional] lpInBuffer
Pointer to an input buffer containing information needed for the operation, or NULL if no information is needed.
[in] cbInBufferSize
The allocated size (in bytes) of the input buffer.
[out, optional] lpOutBuffer
Pointer to an output buffer to receive the data resulting from the operation, or NULL if no data will be returned.
[in] cbOutBufferSize
The allocated size (in bytes) of the output buffer.
[out, optional] lpBytesReturned
Returns the actual size (in bytes) of the data resulting from the operation. If this information is not needed, pass NULL for lpBytesReturned.
Return value
The function returns one of the following values.
Return code | Description |
---|---|
|
The operation was successful. If the operation required an output buffer, lpBytesReturned (if not NULL on input) points to the actual size of the data returned in the buffer. |
|
The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpBytesReturned parameter (if not NULL on input) points to the size required for the output buffer. Only operations requiring an output buffer return ERROR_MORE_DATA. If the lpOutBuffer parameter is NULL and the nOutBufferSize parameter is zero, then ERROR_SUCCESS may be returned, not ERROR_MORE_DATA. |
The operation was not successful. If the operation required an output buffer, the value specified by lpBytesReturned (if not NULL on input) is unreliable. |
Requirements
Requirement | Value |
---|---|
Minimum supported client | None supported |
Minimum supported server | Windows Server 2016 |
Target Platform | Windows |
Header | clusapi.h |
Library | ClusAPI.lib |
DLL | ClusAPI.dll |