CLUSCTL_RESOURCE_GET_REQUIRED_DEPENDENCIES control code

Article
05/31/2018

Retrieves a list of all required dependencies for a resource. Applications use this control code as a ClusterResourceControl parameter, and resource DLLs receive the control code as a parameter to the ResourceControl function.

ClusterResourceControl( 
  hResource,                                  // resource handle
  hHostNode,                                  // optional host node
  CLUSCTL_RESOURCE_GET_REQUIRED_DEPENDENCIES, // this control code
  NULL,                                       // not used
  0,                                          // not used
  lpOutBuffer,                                // output buffer: value list
  cbOutBufferSize,                            // buffer size (bytes)
  lpcbBytesReturned );                        // returned data size (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 value list containing a CLUSPROP_REQUIRED_DEPENDENCY union for each dependency.

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

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

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

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_RESOURCE (0x1)
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 has required dependencies, you must support the CLUSCTL_RESOURCE_GET_REQUIRED_DEPENDENCIES control code in your implementation of ResourceControl. Return a value list containing one CLUSPROP_REQUIRED_DEPENDENCY union for each resource on which your resource is required to depend. Remember to terminate the list with CLUSPROP_SYNTAX_ENDMARK.

For example, if your resource has required dependencies on a storage class resource and a Network Name resource, ResourceControl 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.

The Resource Monitor provides no default processing.

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

Examples

#include <windows.h>
#include <ClusApi.h>

//////////////////////////////////////////////////////////////////////

#include "ClusDocEx.h"

//////////////////////////////////////////////////////////////////////

#ifndef _CLUSDOCEX_RESGETREQDEPS_CPP
#define _CLUSDOCEX_RESGETREQDEPS_CPP


LPVOID ClusDocEx_ResGetRequiredDependencies
(
    IN HRESOURCE hRes,
    IN HNODE     hNode,
    OUT LPDWORD  lpcbDataSize
)
-------------------------------------|--------------------------------------------------------------------------------------|
| Minimum supported client<br/> | None supported<br/>                                                            |
| Minimum supported server<br/> | Windows Server 2008 Enterprise, Windows Server 2008 Datacenter<br/>            |
| Header<br/>                   | <dl> <dt>ClusAPI.h</dt> </dl> |



## See also

<dl> <dt>

[External Resource Control Codes](external-resource-control-codes.md)
</dt> <dt>

[**ClusterResourceControl**](/previous-versions/windows/desktop/api/ClusAPI/nf-clusapi-clusterresourcecontrol)
</dt> <dt>

[**ResourceControl**](/previous-versions/windows/desktop/api/ResApi/nc-resapi-presource_control_routine)
</dt> </dl>

Share via