NAME

   CL_CertAbortQuery,
   CSSM_CL_CertAbortQuery function - Terminate a results handle (CDSA)

 SYNOPSIS

   # include <cssm.h>

        API:
        CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE ResultsHandle)

        SPI:
        CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE ResultsHandle)

 LIBRARY

   Common Security Services Manager library (CDSA$INCSSM300_SHR.EXE)

 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 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
   certificate fields identified by a single OID. The ResultsHandle was
   created and returned by CSSM_CL_CertGetFirstFieldValue() (CSSM API),
   or CL_CertGetFirstFieldValue() (CL SPI), or
   CSSM_CL_CertGetFirstCachedFieldValue() (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_CertGetNextFieldValue() (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 ResultsHandle.

   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 represent an error condition.

 ERRORS

   Errors are described in the CDSA technical standard.  See CDSA.

        CSSMERR_CL_INVALID_RESULTS_HANDLE

 SEE ALSO

   Books

   Intel CDSA Application Developer's Guide (see CDSA)

   Other Help Topics

   Functions for the CSSM API:

       CSSM_CL_CertGetFirstFieldValue
       CSSM_CL_CertGetNextFieldValue
       CSSM_CL_CertGetFirstCachedFieldValue
       CSSM_CL_CertGetNextCachedFieldValue

   Functions for the CLI SPI:

       CL_CertGetFirstFieldValue
       CL_CertGetNextFieldValue
       CL_CertGetFirstCachedFieldValue
       CL_CertGetNextCachedFieldValue