다음을 통해 공유

CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES control code

  • 아티클

Retrieves the read-only common properties for a resource. Applications use this control code as a ClusterResourceControl parameter, and resource DLLs receive the control code as a ResourceControl parameter.

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

lpOutBuffer

On a successful return, points to a property list containing the resource's read-only common resource properties.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

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

1

Incorrect 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 information on working with property lists, see Using Property Lists.

Do not use the CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES 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_RO_COMMON_PROPERTIES 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_RO_COMMON_PROPERTIES (0x55)
Access code 0 1 CLUS_ACCESS_READ (0x1)

Resource DLL Support

Use default. Whether or not your implementation of ResourceControl performs processing for CLUSCTL_RESOURCE_GET_RO_COMMON_PROPERTIES, return ERROR_INVALID_FUNCTION to let the Resource Monitor create the property list. The Resource Monitor will return a version-appropriate list of resource common properties.

As a general guideline, the Resource Monitor should handle all of the control codes for common properties, while your DLL should handle all control codes for private properties.

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

Examples

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

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

#include "ClusDocEx.h"

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

#ifndef _CLUSDOCEX_RESGETROCPROPS_CPP
#define _CLUSDOCEX_RESGETROCPROPS_CPP

LPVOID ClusDocEx_ResGetROCProperties
(
    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>

[**Name**](resources-name.md)
</dt> <dt>

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