CLUSCTL_RESOURCE_GET_REGISTRY_CHECKPOINTS control code

Article
05/31/2018

Retrieves a list of all the registry checkpoints set for a resource. Applications use this control code as a ClusterResourceControl parameter.

ClusterResourceControl( hResource,            // resource handle
                        hHostNode,            // optional host node
                        CLUSCTL_RESOURCE_GET_REGISTRY_CHECKPOINTS,
                        NULL,                 // not used
                        0,                    // not used
                        lpOutBuffer,          // output buffer: array of strings
                        cbOutBufferSize,      // allocated buffer size (bytes)
                        lpcbBytesReturned );  // size of returned data (bytes)

Parameters

The following control code function parameters are specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpOutBuffer: On a successful return, points to an array of null-terminated Unicode strings with an additional NULL terminator appended to the last string. Each string in the array contains a registry key that has previously been added to the resource's list of checkpoints with the CLUSCTL_RESOURCE_ADD_REGISTRY_CHECKPOINT control code.

Return value

ClusterResourceControl returns one of the following values:

ERROR_SUCCESS

The operation was successful. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

The output buffer pointed to by the lpOutBuffer parameter 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

The operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

If the lpOutBuffer parameter is NULL and the cbOutBufferSize parameter is zero, then ERROR_SUCCESS may be returned, not ERROR_MORE_DATA.

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

Resource DLL Support

The CLUSCTL_RESOURCE_GET_REGISTRY_CHECKPOINTS control code is handled by the Cluster service and is not passed to resource DLLs.

Examples

#include <windows.h>

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

#include "ClusDocEx.h"

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

#ifndef _CLUSDOCEX_RESGETREGISTRYCHECKPOINTS_CPP
#define _CLUSDOCEX_RESGETREGISTRYCHECKPOINTS_CPP

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

[**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