CLUSCTL_RESOURCE_TYPE_GET_FLAGS control code

Article
05/31/2018

Retrieves the flags that are set for a resource type. 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 callback function.

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

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, contains a DWORD bitmask describing flags set for the resource type, as follows.

Flag	Description
0	No flags are defined for the resource type.
Nonzero	Indicates a user-defined flag created by a third party developer for a custom 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_FLAGS 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_FLAGS (0x9)
Access code	0 1	CLUS_ACCESS_READ (0x1)

For more information, see Control Code Architecture

Resource DLL Support

Optional. Support CLUSCTL_RESOURCE_TYPE_GET_FLAGS only if you define flags specific to the resource type. The Failover Cluster API reserves only the lower 16 bits of the DWORD bitmask. Use the upper 16 bits to define your own resource type-specific flags. Be sure to document or otherwise communicate what your flags do and how they should be used.

If you do not define resource type-specific flags, return ERROR_INVALID_FUNCTION to let the Resource Monitor handle the operation. The Resource Monitor will read the Flags value from the resource type key in the cluster database.

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