CL_CertAbortQuery(3)CL_CertAbortQuery(3)NAME
CL_CertAbortQuery, CSSM_CL_CertAbortQuery function - Terminate a
results handle (CDSA)
SYNOPSIS
# include <cdsa/cssm.h>
API: CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery (CSSM_CL_HANDLE CLHan‐
dle, CSSM_HANDLE ResultsHandle)
SPI: CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery (CSSM_CL_HANDLE CLHan‐
dle, CSSM_HANDLE ResultsHandle)
LIBRARY
Common Security Services Manager library (libcssm.so)
PARAMETERS
The handle that describes the add-in certificate library module used to
perform this function. A pointer to the handle that identifies the
results of a CSSM_CL_GetFieldValue() (CSSM API), or CL_GetFieldValue()
(CLI SPI) request.
DESCRIPTION
This function terminates a results handle used to access multiple cer‐
tificate fields identified by a single OID. The ResultsHandle was cre‐
ated and returned by CSSM_CL_CertGetFirstFieldValue() (CSSM API), or
CL_CertGetFirstFieldValue() (CL SPI), or CSSM_CL_CertGetFirstCached‐
FieldValue() (CSSM API), or CL_CertGetFirstCachedFieldValue() (CL SPI).
The CL releases all intermediate state information associated with the
repeating-value query. Once this function has been invoked, the results
handle is invalid.
Applications must invoke this function to terminate the ResultsHandle.
Using CSSM_CL_CertGetNextFieldValue() (CSSM API), or CL_CertGet‐
NextFieldValue() (CL SPI), or CSSM_CL_CertGetNextCachedFieldValue()
(CSSM API), or CL_CertGetNextCachedFieldValue() (CL SPI), to access all
of the attributes named by a single OID does not terminate the Result‐
sHandle.
This function can be invoked to terminate the results handle without
accessing all 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 repre‐
sent 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_CertGetFirstFieldValue(3), CSSM_CL_CertGetNextFieldValue(3),
CSSM_CL_CertGetFirstCachedFieldValue(3), CSSM_CL_CertGetNextCached‐
FieldValue(3)
Functions for the CLI SPI:
CL_CertGetFirstFieldValue(3), CL_CertGetNextFieldValue(3), CL_CertGet‐
FirstCachedFieldValue(3), CL_CertGetNextCachedFieldValue(3)CL_CertAbortQuery(3)