NAME

CL_CrlRetrieve

SYNOPSIS

CSSM_DATA_PTR CSSMCLI CL_CrlRetrieve
    (CSSM_CL_HANDLE CLHandle,
    const CSSM_DATA_PTR ReferenceIdentifier,
    const CSSM_NET_ADDRESS_PTR CALocation,
    sint32 *EstimatedTime)

DESCRIPTION

This function returns the CRL closed and issued in response to the CL_CrlRequest function call. The reference identifier denotes the corresponding call.

It is possible that the CRL is not ready to be retrieved when this call is made. In that case, an EstimatedTime to complete the CRL issuing process is returned with the reference identifier and a NULL certificate pointer. The caller must attempt to retrieve the CRL again after the estimated time to completion has elapsed.

PARAMETERS

CLHandle (input)

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

ReferenceIdentifier (input)

A reference identifier which uniquely identifies the CSSM_CL_CrlRequest call that initiated the CRL issuing request. The identifier persists across application executions until it is terminated by successful or failed completion of the CSSM_CL_CrlRetrieve function.

CALocation (input/optional)

A pointer to a network address directly or indirectly identifying the location of the CA process. If the input is NULL, the module can determine a CA process and its location based on state information associated with the ReferenceIdentifier or can assume a default CA process location. If insufficient state is associated with the ReferenceIdentifier and a default cannot be assumed, the retrieval cannot be completed and the operation fails.

EstimatedTime (output)

The number of seconds estimated before the CRL will be returned. A (default) value of zero indicates that the CRL has been returned as a result of this call. When the certification process cannot estimate the time required to prepare the CRL, the output value for estimated time is CSSM_ESTIMATED_TIME_UNKNOWN.

RETURN VALUE

A pointer to the CSSM_DATA structure containing the CRL. If the pointer is NULL, the calling application is expected to call back after the specified EstimatedTime. If the pointer is NULL and EstimatedTime is zero, an error has occurred. If the EstimatedTime is CSSM_ESTIMATED_TIME_UNKNOWN, the call back time is not defined and the application must periodically poll for completion. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_CL_INVALID_CL_HANDLE

Invalid Certificate Library Handle.

CSSM_CL_INVALID_IDENTIFIER

Invalid reference identifier.

CSSM_CL_CERT_SIGN_FAIL

Unable to sign CRL.

CSSM_CL_EXTRA_SERVICE_FAIL

Unable to perform additional CRL-related services.

CSSM_CL_MEMORY_ERROR

Not enough memory.

SEE ALSO

CL_CrlRequest