NAME

   CL_CrlGetAllCachedRecordFields,
   CSSM_CL_CrlGetAllCachedRecordFields - Return field values from a CRL
                                         record (CDSA)

 SYNOPSIS

   # include <cssm.h>

    API:
        CSSM_RETURN CSSMAPI CSSM_CL_CrlGetAllCachedRecordFields
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE CrlHandle,
        const CSSM_DATA *CrlRecordIndex,
        uint32 *NumberOfFields,
        CSSM_FIELD_PTR *Fields)

    SPI:
        CSSM_RETURN CSSMCLI CL_CrlGetAllCachedRecordFields
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE CrlHandle,
        const CSSM_DATA *CrlRecordIndex,
        uint32 *NumberOfFields,
        CSSM_FIELD_PTR *Fields)

 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.

   CrlHandle (input)
           A handle identifying a CRL that the application has temporarily
           cached with the Certificate Library module. The referenced CRL
           must contain the CRL record identified by CrlRecordIndex.

   CrlRecordIndex (input)
           An index value identifying a particular revocation record in a
           cached CRL.

   NumberOfFields (output)
           The number of OID-value pairs returned by this function.

   Fields (output)
           A pointer to an array of CSSM_FIELD structures, describing the
           contents of the preselected CRL record using OID-value pairs.
           The field list is allocated by the service provider and must
           be deallocated by the application by calling
           CSSM_CL_FreeFields() (CSSM API), or CL_FreeFields() (CL SPI).

 DESCRIPTION

   This function returns all field values from a prelocated, cached CRL
   record. The scanned CRL record is identified by CrlRecordIndex, which
   is returned by the function CSSM_CL_IsCertInCachedCrl() (CSSM API), or
   CL_IsCertInCachedCrl() (CL SPI).

   Fields are returned as a set of OID-value pairs. The OID identifies the
   CRL record field and the data format of the value extracted from that
   field.  The Certificate Library module defines and uses a preferred
   data format for returning field values in this function.

   Each CRL record may be digitally signed when it is added to the CRL
   using the function CSSM_CL_CrlAddCert() (CSSM API), or CL_CrlAddCert()
   (CL SPI).  This function does not perform any signature verification
   on the CRL record.

 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_CACHE_HANDLE
        CSSMERR_CL_INVALID_CRL_INDEX

 SEE ALSO

   Books

   Intel CDSA Application Developer's Guide (see CDSA)

   Other Help Topics

   Functions for the CSSM API:

       CSSM_CL_IsCertInCachedCrl
       CSSM_CL_CrlCache
       CSSM_CL_CrlAbortCache
       CSSM_CL_FreeFields

   Functions for the CLI SPI:

       CL_IsCertInCachedCrl
       CL_CrlCache
       CL_CrlAbortCache
       CL_FreeFields