CL_CrlDescribeFormat

NAME

  CL_CrlDescribeFormat,
  CSSM_CL_CrlDescribeFormat - Return a list of the CSSM_OID values (CDSA)

SYNOPSIS

  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_CL_CrlDescribeFormat
       (CSSM_CL_HANDLE CLHandle,
       uint32 *NumberOfOids,
       CSSM_OID_PTR *OidList)

   SPI:
       CSSM_RETURN CSSMCLI CL_CrlDescribeFormat
       (CSSM_CL_HANDLE CLHandle,
       uint32 *NumberOfOid,
       CSSM_OID_PTR *OidList)

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.

  NumberOfOids (output)
          The length of the returned array of OIDs.

  OidList (output)
          A pointer to the array of CSSM_OIDs that represent the
          supported CRL format. The OID list is allocated by the service
          provider and must be deallocated by the application.

DESCRIPTION

  This function returns a list of the CSSM_OID values the Certificate
  Library module uses to name and reference fields of a CRL. Multiple
  CSSM_OID values can correspond to a single field. These OIDs can be
  provided as input to CSSM_CL_CrlGetFirstFieldValue() (CSSM API), or
  CL_CrlGetFirstFieldValue() (CL SPI), calls to retrieve field values
  from the CRL. The OID also implies the data format of the returned
  value.  When multiple OIDs name the same field of a CRL, those OIDs
  have different return data formats associated with them.

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.

  None specific to this call.

SEE ALSO

  Intel CDSA Application Developer's Guide (see CDSA)