CLUSCTL_RESOURCE_DELETE_REGISTRY_CHECKPOINT control code

2018-05-31

Removes a registry tree from the list of registry trees that are being replicated for a resource. Applications use this control code as a ClusterResourceControl parameter.

ClusterResourceControl( 
  hResource,                                   // resource handle
  hHostNode,                                   // optional node handle
  CLUSCTL_RESOURCE_DELETE_REGISTRY_CHECKPOINT, // this control code 
  lpInBuffer,                                  // input buffer: string
  cbInBufferSize,                              // input buffer size (bytes)
  NULL,                                        // not used
  0,                                           // not used
  NULL );                                      // not used

Parameters

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

lpInBuffer: Pointer to a null-terminated Unicode string containing the registry key name at the root of the subtree that should be replicated for the resource. This is a key name that is relative to HKEY_LOCAL_MACHINE, such as Software\Microsoft\My Application. Do not use a leading backslash character ("\") in the relative path or the call will fail.

Return value

ClusterResourceControl returns one of the following values:

ERROR_SUCCESS: The operation was successful.
ERROR_FILE_NOT_FOUND: The specified key is not currently being checkpointed.
System error code: The operation failed.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_DELETE_REGISTRY_CHECKPOINT 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_MODIFY (0x1)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_DELETE_REGISTRY_CHECKPOINT (0x4000a6)
Access code	0 1	CLUS_ACCESS_WRITE (0x2)

Resource DLL Support

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

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	ClusAPI.h

Share via