CLUSCTL_GROUP_GET_FAILURE_INFO control code

Retrieves information about a group failure. Applications use this control code as a ClusterGroupControl parameter.

ClusterGroupControl( 
  hGroup,                                // group handle
  hHostNode,                             // optional node handle
  CLUSCTL_GROUP_GET_FAILURE_INFO,        // this control code
  lpInBuffer,                            // input buffer
  nInBufferSize,                         // input buffer size
  lpOutBuffer,                           // output buffer
  nOutBufferSize,                        // output buffer size
  lpBytesReturned                        // resulting data size
);

Parameters

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

hGroup [in]

A handle to the group that failed.

hHostNode [in, optional]

A handle to the node that is to perform the operation. If NULL, the node that contains the group performs the operation.

lpInBuffer [in, optional]

A pointer to the input buffer that contains the data for the operation, or NULL if no information is needed.

nInBufferSize [in]

The allocated size of of the lpInBuffer parameter, in bytes.

lpOutBuffer [out, optional]

A pointer to the output buffer that receives the data retrieved by the operation, or NULL if no data will is retrieved.

nOutBufferSize [in]

The allocated size of of the lpOutBuffer parameter, in bytes.

lpBytesReturned [out, optional]

The actual size of the data retrieved by the operation, in bytes.

Return value

When an application uses CLUSCTL_GROUP_GET_FAILURE_INFO as a parameter for ClusterGroupControl, ClusterGroupControl returns one of the following values:

ERROR_SUCCESS

0

The operation completed successfully. This value is returned if the lpBytesReturned 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 buffer for lpOutBuffer was not large enough to hold the data that was returned by the operation.

System error code

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

ClusAPI.h defines the 32 bits of CLUSCTL_GROUP_GET_FAILURE_INFO (0x03000019) 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_FAILURE_INFO (0x19)
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

ClusterGroupControl