CLUSCTL_RESOURCE_TYPE_GET_CHARACTERISTICS control code

Article
05/31/2018

Retrieves the intrinsic characteristics of a resource type. Applications use this control code as a ClusterResourceTypeControl parameter, and resource DLLs receive the control code as a parameter to the ResourceTypeControl function.

ClusterResourceTypeControl( 
  hCluster,                                  // cluster handle
  lpszResTypeName,                           // resource type name
  hHostNode,                                 // optional host node
  CLUSCTL_RESOURCE_TYPE_GET_CHARACTERISTICS, // this control code
  NULL,                                      // input buffer (not used)
  0,                                         // input buffer size (not used)
  lpOutBuffer,                               // output buffer: DWORD bitmask
  cbOutBufferSize,                           // allocated buffer size (bytes)
  lpcbBytesReturned );                       // actual size of resulting data (bytes)

Parameters

The following control code function and DLL support parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceTypeControl or ResourceTypeControl.

lpOutBuffer: On a successful return, contains a DWORD bitmask describing the resource type's characteristics as one of the following values enumerated from the CLUS_CHARACTERISTICS enumeration.
CLUS_CHAR_UNKNOWN (0x00000000): Resources of this type have no known characteristics.
CLUS_CHAR_QUORUM (0x00000001): Resources of this type are capable of being the quorum resource type for a cluster.
CLUS_CHAR_DELETE_REQUIRES_ALL_NODES (0x00000002): Resources of this type cannot be deleted unless all nodes are active.
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

ClusterResourceTypeControl 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: 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: The operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE_TYPE (0x2)
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_CHARACTERISTICS (0x5)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Resource DLL Support

Optional. If you do not support the control code, return ERROR_INVALID_FUNCTION to let the Resource Monitor read the Characteristics value from the resource type key in the cluster database.

If you do support CLUSCTL_RESOURCE_TYPE_GET_CHARACTERISTICS, return a value that accurately describes the resources supported by the resource type. For more information, see CLUSCTL_RESOURCE_GET_CHARACTERISTICS.

For more information on the ResourceTypeControl entry point function, see Implementing ResourceTypeControl.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	ClusAPI.h