NAME

CSSM_CL_CertAbortQuery

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery
    (CSSM_CL_HANDLE CLHandle,
    CSSM_HANDLE ResultsHandle)

DESCRIPTION

This function terminates the get operation initiated by CSSM_CL_CertGetFirstFieldValue and allows the CL to release all intermediate state information associated with the query. This function should be called even if all values retrieved by the call to CSSM_CL_CertGetFirstFieldValue are obtained by repeated calls to CSSM_CL_CertGetNextFieldValue.

PARAMETERS

CLHandle (input)

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

ResultsHandle (input)

A pointer to the handle which identifies the results of a CSSM_CL_GetFieldValue request.

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_RESULTS_HANDLE

Invalid Results handle.

CSSM_CL_CERT_ABORT_QUERY_FAIL

Unable to abort the certificate query.

SEE ALSO

CSSM_CL_CertGetFirstFieldValue, CSSM_CL_CertGetNextFieldValue