NAME

CL_CrlAbortQuery, CSSM_CL_CrlAbortQuery − Terminate a query (CDSA)

SYNOPSIS

# include <cdsa/cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_CL_CrlAbortQuery
(CSSM_CL_HANDLE CLHandle,
CSSM_HANDLE ResultsHandle)
SPI:
CSSM_RETURN CSSMCLI CL_CrlAbortQuery
(CSSM_CL_HANDLE CLHandle,
CSSM_HANDLE ResultsHandle)

LIBRARY

Common Security Services Manager library (libcssm.so)

PARAMETERS

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

ResultsHandle (input)
The handle that identifies the results of a CRL query.

DESCRIPTION

This function terminates the query initiated by CSSM_CL_CrlGetFirstFieldValue() or CSSM_CL_CrlGetFirstCachedFieldValue() function (or their CL SPI equivalents), and allows the CL to release all intermediate state information associated with the repeating-value get operation. Once this function has been invoked, the results handle is invalid. 

Applications must invoke this function to terminate the ResultsHandle. Using CSSM_CL_CrlGetNextFieldValue() or CSSM_CL_CrlGetNextCachedFieldValue() (or their CL SPI equivalents), to access all of the attributes named by a single OID does not terminate the ResultsHandle. This function can be invoked to terminate the results handle without accessing all of the values identified by the single OID. 

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition. 

ERRORS

Errors are described in the CDSA technical standard.  See CDSA_intro(3). 

CSSMERR_CL_INVALID_RESULTS_HANDLE

SEE ALSO

Books

Intel CDSA Application Developer’s Guide (see CDSA_intro(3))

Reference Pages

Functions for the CSSM API:

CSSM_CL_CrlGetFirstFieldValue(3), CSSM_CL_CrlGetNextFieldValue(3), CSSM_CL_CrlGetFirstCachedFieldValue(3), CSSM_CL_CrlGetNextCachedFieldValue(3)

Functions for the CL SPI:

CL_CrlGetFirstFieldValue(3), CL_CrlGetNextFieldValue(3), CL_CrlGetFirstCachedFieldValue(3), CL_CrlGetNextCachedFieldValue(3)