ClusterGroupControl

The ClusterGroupControl function initiates an operation that affects a group.

DWORD WINAPI ClusterGroupControl(
  HGROUP hGroup,         
  HNODE hHostNode,       
  DWORD dwControlCode,   
  LPVOID lpInBuffer,     
  DWORD cbInBufferSize,   
  LPVOID lpOutBuffer,    
  DWORD cbOutBufferSize,  
  LPDWORD lpcbBytesReturned   
);
 

Parameters

hGroup

[in] Handle to the group to be affected.

hHostNode

[in] If non-NULL, handle to the node to perform the operation represented by the control code. If NULL, the node that owns the group performs the operation. Specifying hHostNode is optional.

dwControlCode

[in] Control code that defines the operation to be performed. For a list of the valid values for the dwControlCode parameter, see Control Codes for Groups.

lplnBuffer

[in] Pointer to the input buffer with information needed for the operation, or NULL if no information is needed.

cblnBufferSize

[in] Number of bytes in the buffer pointed to by lplnBuffer.

lpOutBuffer

[out] Pointer to the output buffer with information resulting from the operation, or NULL if nothing need be returned.

cbOutBufferSize

[in] Number of bytes in the output buffer pointed to by lpOutBuffer.

lpcbBytesReturned

[in, out] Pointer to the number of bytes in the buffer pointed to by lpOutBuffer that were actually filled as a result of the operation. The caller can pass NULL for lpcbBytesReturned if ClusterGroupControl need not pass back the number of bytes in the output buffer.

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_MORE_DATA

The output buffer pointed to by lpOutBuffer is not large enough to hold the data being returned. The lpcbBytesReturned parameter points to the size required for the output buffer.

If the operation was unsuccessful, ClusterGroupControl returns a Win32 error value.

Remarks

ClusterGroupControl is a general-purpose function for initiating an operation that affects a group. The scope of allowable operations is defined by the set of control codes specified for groups. For a complete description of how to use control codes and control code functions, see Cluster Control Codes.

When ClusterGroupControl returns ERROR_MORE_DATA, set cbOutBufferSize to the number of bytes pointed to by lpcbBytesReturned and call the function again.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.