CL_FreeFields

NAME

  CL_FreeFields,
  CSSM_CL_FreeFields - Free fields (CDSA)

SYNOPSIS

  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_CL_FreeFields
       (CSSM_CL_HANDLE CLHandle,
       uint32 NumberOfFields,
       CSSM_FIELD_PTR *FieldArray)

   SPI:
       CSSM_RETURN CSSMCLI CL_FreeFields
       (CSSM_CL_HANDLE CLHandle,
       uint32 NumberOfFields,
       CSSM_FIELD_PTR *FieldArray)

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.

  NumberOfFields (input)
          The length of the array of fields in FieldArray.

  FieldArray (input)
          A pointer to an array of CSSM_FIELD structures that need to be
          deallocated.

DEFINITIONS

  This function frees the fields in the FieldArray by freeing the data
  pointers for both the FieldOid and FieldValue fields. It also frees the
  top level FieldArray pointer.

  This function should be used only to free CSSM_FIELD_PTR values
  returned from calls CSSM_TP_CertGetAllTemplateFields(),
  CSSM_CL_CertGetAllTemplateFields(), CSSM_CL_CertGetAllFields(),
  CSSM_CL_CrlGetAllFields(), CSSM_CL_CrlGetAllCachedRecordFields(),
  or their SPI equivalent calls.

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)