NAME

CSSM_KR_RegistrationRequest

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_KR_RegistrationRequest
    (CSSM_CC_HANDLE RecoveryRegistrationContext,
    CSSM_DATA_PTR KRInData,
    CSSM_CRYPTO_DATA_PTR UserCallback,
    Uint8 KRFlags,
    uint32 *EstimatedTime,
    CSSM_HANDLE_PTR ReferenceHandle )

DESCRIPTION

This function initiates a key recovery registration operation. The KRInData contains known input parameters for the recovery registration operation. A UserCallback function can be supplied to allow the registration operation to interact with the user interface, if necessary.

This function returns a ReferenceHandle and an EstimatedTime for completion of the request. The ReferenceHandle must be used to retrieve the registration result using the CSSM_KR_RegistrationRetrieve() function after the EstimatedTime has elapsed. The return value for this function indicates whether the request was successfully initiated.

PARAMETERS

RecoveryRegistrationContext (input)

The handle to the key recovery registration context.

KRInData (input)

Input data for key recovery registration.

UserCallback (input/optional)

A callback function that may be used to collect further information from the user interface.

KRFlags (input)

Flag values for recovery registration. Defined values are:

• KR_INDIV-registration for individual key recovery

• KR_ENT-registration for enterprise key recovery

• KR_LE-registration for law enforcement key recovery

EstimatedTime (output)

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

ReferenceHandle (output)

A handle that references the outstanding registration request. This handle must be used to retrieve the registration result using the function CSSM_KR_RegistrationRetrieve.

RETURN VALUES

A CSSM return value. This function returns CSSM_OK if successful and returns an error code if an error has occurred.

ERRORS

CSSM_KR_INVALID_HANDLE

Invalid registration handle.

CSSM_KR_INVALID_POINTER

Invalid pointer.

CSSM_MEMORY_ERROR

Memory error.