This function completes a key recovery request operation. The ReferenceHandle parameter indicates which outstanding recovery request is to be completed. The results of a successful recovery operation are referenced by the ResultsHandle parameter, which may be used with the CSSM_KR_GetRecoveredObject function to retrieve the recovered keys.

If the results are not available at the time this function is invoked, the CacheHandle is NULL, and the EstimatedTime parameter indicates when this operation should be repeated with the same ReferenceHandle.

CSSM_RETURN CSSMAPI CSSM_KR_RecoveryRetrieve
               (CSSM_KRSP_HANDLE KRSPHandle,
               CSSM_HANDLE_PTR ReferenceHandle,
               unit32 *EstimatedTime,
               CSSM_HANDLE_PTR CacheHandle,
               unit32 *NumberOfRecoveredKeys)

Input

KRSPHandle

The handle to the KRSP that is to be used.

ReferenceHandle

Handle that indicates which key recovery request operation is to be completed.

Output

EstimatedTime

The estimated time after which this call should be repeated to obtain recovery results. This is set to a non-zero value only when the ResultsHandle parameter is NULL.

CacheHandle

Handle returned when recovery operation is successful. This handle may be used to get individual keys using the CSSM_KR_GetRecoveredObject function. This handle is NULL if the EstimatedTime parameter is not zero.

NumberOfRecoveredKeys

The number of recovered key objects that may be obtained using the ResultsHandle.

CSSM_OK if successful, CSSM_FAIL if an error occurred. Use CSSM_GetError to determine the exact error.