CLUSCTL_RESOURCE_GET_CRYPTO_CHECKPOINTS control code

Retrieves a list of all the cryptographic key checkpoints set for a resource.

ClusterResourceControl( 
  hResource,                               // resource handle
  hHostNode,                               // optional host node
  CLUSCTL_RESOURCE_GET_CRYPTO_CHECKPOINTS, // control code
  NULL,                                    // lpInBuffer (not used)
  0,                                       // nInBufferSize (not used)
  lpOutBuffer,                             // output buffer: array of strings
  cbOutBufferSize,                         // allocated buffer size (bytes)
  lpcbBytesReturned );                     // size of resulting data (bytes)

Parameters

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

lpOutBuffer [in, out]

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 cryptographic service provider (CSP) type, provider name, and key container name in the following format:

Type\Name\Key

Note the values are separated by a '\'. The provider type specifies the decimal value of the type, not the constant that represents the value. For example, "1" instead of "PROV_RSA_FULL". The provider name may be omitted, indicating that the default CSP name associated with the specified provider type should be used.

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

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

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.

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_GET_CRYPTO_CHECKPOINTS as follows (for more information, see Control Code Architecture).

Resource DLL Support

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

Requirements

See also

ClusterResourceControl

ResourceControl

CLUSCTL_RESOURCE_ADD_CRYPTO_CHECKPOINT

CLUSCTL_RESOURCE_DELETE_CRYPTO_CHECKPOINT