CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES control code

Article
05/31/2018

Retrieves a list of all required dependencies for a resource type. Applications use this control code as a ClusterResourceTypeControl parameter, and resource DLLs receive the control code as a ResourceTypeControl parameter.

ClusterResourceTypeControl( 
  hCluster,                                          // cluster handle
  lpszResTypeName,                                   // resource type name
  hHostNode,                                         // optional host node
  CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES,   // this control code
  NULL,                                              // input buffer (not used)
  0,                                                 // input buffer size (not used)
  lpOutBuffer,                                       // output buffer: value list
  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 value list containing a CLUSPROP_REQUIRED_DEPENDENCY union for each dependency.

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

For examples of using CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES, see Creating a Value List and Parsing a Value List.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES 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_REQUIRED_DEPENDENCIES (0x11)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Resource DLL Support

Conditional. If your resource type has required dependencies, support the CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES control code in your implementation of ResourceTypeControl. Return a value list containing one CLUSPROP_REQUIRED_DEPENDENCY union for each resource on which resources of this type are required to depend. Remember to terminate the list with CLUSPROP_SYNTAX_ENDMARK.

For example, if your resource type has required dependencies on a storage class device and a Network Name resource type, ResourceTypeControl should return a value list with three entries:

A CLUSPROP_REQUIRED_DEPENDENCY union with the ResClass member set to CLUS_RESCLASS_STORAGE.
A CLUSPROP_REQUIRED_DEPENDENCY union with the ResTypeName member set to "Network Name".
A CLUSPROP_VALUE structure with the Syntax member set to CLUSPROP_SYNTAX_ENDMARK.

(For an example, see Creating a Value List.) The Resource Monitor provides no default processing.

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

Share via