CLUSCTL_RESOURCE_TYPE_GET_CLASS_INFO control code

Article
05/31/2018

Retrieves the class and subclass of a resource type. A resource type class identifies resource types of similar capability. Applications use this control code as a parameter to the ClusterResourceTypeControl function, and resource DLLs receive the control code as a parameter to the ResourceTypeControl function.

A resource DLL receives the CLUSCTL_RESOURCE_TYPE_GET_CLASS_INFO control code when an application requests the resource type class of a resource type.

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

Parameters

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

lpOutBuffer: On a successful return, points to a CLUS_RESOURCE_CLASS_INFO structure containing resource type class information for the resource type.

Return value

ClusterResourceTypeControl returns one of the following values.

ERROR_SUCCESS

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. 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, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_GET_CLASS_INFO as follows.

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_CLASS_INFO (0xd)
Access code	0 1	CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture.

Resource DLL Support

Optional. If you do not support it, return ERROR_INVALID_FUNCTION to let the Resource Monitor provide default handling. The Resource Monitor will specify CLUS_RESCLASS_UNKNOWN as the class and zero as the subclass.

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

Requirements


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

Partager via