CL_CrlGetAllFields

NAME

  CL_CrlGetAllFields,
  CSSM_CL_CrlGetAllFields - Get the field values from the CRL (CDSA)

SYNOPSIS

  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_CL_CrlGetAllFields
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *Crl,
       uint32 *NumberOfCrlFields,
       CSSM_FIELD_PTR *CrlFields)

   SPI:
       CSSM_RETURN CSSMCLI CL_CrlGetAllFields
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *Crl,
       uint32 *NumberOfCrlFields,
       CSSM_FIELD_PTR *CrlFields)

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.

  Crl (input)
          A pointer to the CSSM_DATA structure that contains the encoded,
          packed CRL from which field values are to be extracted.

  NumberOfCrlFields (output)
          The number of entries in the array CrlFields.

  CrlFields (output)
          A pointer to an array of OID-value pairs that describe the
          contents of the CRL. The extracted CRL fields are returned
          as the value portion of each OID-value pair. 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 one or more structures. Each structure contains
  a set of field values from the encoded, packed CRL contained in Crl.
  Each structure is returned in the FieldValue entry of the CSSM_FIELD
  structure CrlFields. The parameter NumberOfCrlFields indicates the
  number of returned structures.

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

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_CRL_POINTER
       CSSMERR_CL_UNKNOWN_FORMAT

SEE ALSO

  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  Functions for the CSSM API:

      CSSM_CL_FreeFields

  Functions for the CLI SPI:

      CL_FreeFields