CLUSCTL_RESOURCE_GET_CLASS_INFO control code

Article
05/31/2018

Retrieves the class and subclass of a resource. A resource class identifies resources of similar capability. Applications use this control code as a parameter to the ClusterResourceControl function, and resource DLLs receive the control code as a parameter to the ResourceControl function.

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

ClusterResourceControl( hResource,                       // resource handle
                        hHostNode,                       // optional host node
                        CLUSCTL_RESOURCE_GET_CLASS_INFO, // this control code
                        NULL,                            // input buffer (not used)
                        0,                               // input buffer size (not used)
                        lpOutBuffer,                     // output buffer: CLUS_RESOURCE_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 ClusterResourceControl or ResourceControl.

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

Return value

ClusterResourceControl 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.

Implementations of ResourceControl can return the above values or the following value.

ERROR_INVALID_FUNCTION

Invalid function. Requests that the Resource Monitor perform default processing (if any) for the control code addition to processing supplied by the DLL (if any).

Remarks

Do not use the CLUSCTL_RESOURCE_GET_CLASS_INFO control code in any resource DLL entry point function. This control code 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_RESOURCE_GET_CLASS_INFO as follows.

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE (0x1)
Global bit	23	CLUS_NOT_GLOBAL
Modify bit	22	CLUS_NO_MODIFY
User bit	21	CLCTL_CLUSTER_BASE
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_GET_CLASS_INFO (0xd)
Access code	0 1	CLUS_ACCESS_READ

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 ResourceControl entry point, see Implementing ResourceControl.

Requirements


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

Share via