CLUSCTL_RESOURCE_DELETE_CRYPTO_CHECKPOINT control code

Article
05/31/2018

Removes a cryptographic key container from the list of keys that are being replicated for a resource.

ClusterResourceControl( 
  hResource,                                 // resource handle
  hHostNode,                                 // optional node handle
  CLUSCTL_RESOURCE_DELETE_CRYPTO_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 that specifies the cryptographic service provider type, provider name, and key container name of a key that was previously checkpointed with the CLUSCTL_RESOURCE_ADD_CRYPTO_CHECKPOINT control code.

Return value

ClusterResourceControl returns one of the following values:

ERROR_SUCCESS: The operation was successful.
System error code: The operation failed.

Remarks

For more information on the CryptoAPI, see the Cryptography_Reference.

For more information on cluster programming, refer to the following sections:

For information on working with control codes, see Using Control Codes.
For information on cluster registry checkpointing, see Cluster Database.
Cluster-aware applications need to be compiled and linked using ClusAPI.h, ClusAPI.lib, Resource.h, and ResUtils.lib. For an example of cluster-related compiler directives, see ClusDocEx.h.

ClusAPI.h defines the 32 bits of CLUSCTL_RESOURCE_DELETE_CRYPTO_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_CRYPTO_CHECKPOINT (0x4000b2)
Access code	0 1	CLUS_ACCESS_WRITE (0x2)

Resource DLL Support

The CLUSCTL_RESOURCE_DELETE_CRYPTO_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