NAME

CL_CertAbortRecovery

SYNOPSIS

CSSM_RETURN CSSMCLI CL_CertAbortRecovery
    (CSSM_CL_HANDLE CLHandle,
    CSSM_HANDLE CacheHandle)

DESCRIPTION

This function terminates the iterative process of recovering certificates and their associated private keys from a cache of certificates. This function must be called even if all certificates and their associated private keys are recovered from the cache. This function destroys all intermediate state and secret information used during the certificate and key recovery process. At completion of this function, the specified cache handle is invalid and the operations CSSM_CL_CertRecover and CSSM_CL_CertRecoverKey can no be invoked using this handle.

PARAMETERS

CLHandle (input)

The handle that describes the add-in certificate library module used to perform this function.

CacheHandle (input)

A handle which identifies the cache of retrieved, recovered certificates and their associated private keys.

RETURN VALUE

CSSM_OK if the function was successful. CSSM_FAIL if an error condition occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_CL_INVALID_CL_HANDLE

Invalid Certificate Library Handle.

CSSM_CL_INVALID_HANDLE

Invalid cache handle.

CSSM_CL_ABORT_RECOVERY_FAIL

Unable to abort the recovery process.

SEE ALSO

CL_CertRecoveryRequest, CL_CertRecoveryRetrieve,
CL_CertRecover, CL_CertRecoverKey