CL_CertGetAllTemplateFields

NAME

  CL_CertGetAllTemplateFields,
  CSSM_CL_CertGetAllTemplateFields - Extract and return values stored
                                     in CertTemplate (CDSA)

SYNOPSIS

  # include <cssm.h>

       API:
       CSSM_RETURN CSSMAPI CSSM_CL_CertGetAllTemplateFields
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *CertTemplate,
       uint32 *NumberOfFields,
       CSSM_FIELD_PTR *CertFields)
       SPI:
       CSSM_RETURN CSSMCLI CL_CertGetAllTemplateFields
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *CertTemplate,
       uint32 *NumberOfFields,
       CSSM_FIELD_PTR *CertFields)

LIBRARY

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

PARAMETERS

  CLHandle (input)
          The handle that describes the certificate library module used
          to perform this function.

  CertTemplate (input)
          A pointer to the CSSM_DATA structure containing the packed,
          encoded certificate template.

  NumberOfFields (output)
          The length of the output array of fields.

  CertFields (output)
          A pointer to an array of CSSM_FIELD structures which contains
          the OIDs and values of the fields of the input certificate
          template.

DESCRIPTION

  This function extracts and returns a copy of the values stored
  in the encoded CertTemplate. The memory for the CertFields
  output is allocated by the service provider using the calling
  application's memory management routines. The application must
  deallocate the memory by calling CSSM_CL_FreeFields() (CSSM
  API), or CL_FreeFields() (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_UNKNOWN_FORMAT

SEE ALSO

  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  Functions for the CSSM API:

      CSSM_CL_FreeFields
      CSSM_CL_CertCreateTemplate

  Functions for the CLI SPI:

      CL_FreeFields
      CL_CertCreateTemplate