CLUSCTL_GROUP_GET_CHARACTERISTICS control code

Retrieves the intrinsic characteristics of a group. Applications use this control code as a parameter to the ClusterGroupControl function.

ClusterGroupControl( 
  hGroup,                            // group handle
  hHostNode,                         // optional node handle
  CLUSCTL_GROUP_GET_CHARACTERISTICS, // this control code
  NULL,                              // input buffer (not used)
  0,                                 // input buffer size (not used)
  lpOutBuffer,                       // output buffer: DWORD bitmask
  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 ClusterGroupControl.

lpOutBuffer

On a successful return, contains a DWORD bitmask describing the group's characteristics enumerated from the CLUS_CHARACTERISTICS enumeration. Only one value is currently defined.

CLUS_CHAR_UNKNOWN (0x00000000)

The Network Interface has no known characteristics.

CLUS_CHAR_DELETE_REQUIRES_ALL_NODES (0x00000002)

Resources of this type cannot be deleted unless all nodes are active.

CLUS_CHAR_REQUIRES_STATE_CHANGE_REASON (0x00000010)

The resource DLL will receive the CLUSCTL_RESOURCE_STATE_CHANGE_REASON control code.

CLUS_CHAR_SINGLE_CLUSTER_INSTANCE (0x00000040)

Only one instance of this resource type is allowed in a cluster.

CLUS_CHAR_SINGLE_GROUP_INSTANCE (0x00000080)

Only one instance of this resource type is allowed in a group.

Return value

ClusterGroupControl returns one of the following values.

ERROR_SUCCESS

The operation completed successfully. This value is returned if the lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

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

Do not use any group control codes in any resource DLL entry point function. Group control codes can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

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

Requirements

See also

Group Control Codes

ClusterGroupControl

CLUS_CHARACTERISTICS