NAME

CSSM_CL_CertRecover

SYNOPSIS

CSSM_DATA_PTR CSSMAPI CSSM_CL_CertRecover
    (CSSM_CL_HANDLE CLHandle,
    CSSM_HANDLE CacheHandle,
    const uint32 CacheIndex)

DESCRIPTION

This function returns a certificate from a cache of certificates retrieved by the CSSM_CL_CertRecoveryRetrieve function. The cache contains a set of certificates in unspecified order. The certificate to be retrieved is specified by the CacheIndex parameter, which is a simple counter from one to the number of certificates in the cache. The selected certificate is returned as a result of the function call.

This function has no effect on the private key associated with the recovered certificate. Recovery of the private key can be performed using the function CSSM_CL_CertKeyRecover.

PARAMETERS

CLHandle (input)

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

CacheHandle (input)

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

CacheIndex (input)

An index value that selects a certificate from the ordered cache of retrieved, recovered certificates and associated keys. The value must be less than or equal to the number of certificates in the cache.

RETURN VALUE

A pointer to the CSSM_DATA structure containing the recovered certificate. If the pointer is NULL, an error has 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_INVALID_INDEX

Cache index value is out of range.

CSSM_CL_MEMORY_ERROR

Not enough memory.

SEE ALSO

CL_CertRecoveryRequest, CSSM_CL_CertRecoveryRetrieve,
CSSM_CL_CertKeyRecover, CSSM_CL_CertAbortRecovery