CL_FreeFieldValue

NAME

  CL_FreeFieldValue,
  CSSM_CL_FreeFieldValue - Free field data (CDSA)

SYNOPSIS

  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_CL_FreeFieldValue
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_OID *CertOrCrlOid,
       CSSM_DATA_PTR Value)

   SPI:
       CSSM_RETURN CSSMCLI CL_FreeFieldValue
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_OID *CertOrCrlOid,
       CSSM_DATA_PTR Value)

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.

  CertOrCrlOid (input)
          A pointer to the CSSM_OID structure describing the type of the
          Value to be freed.

  Value (input)
          A pointer to the CSSM_DATA structure containing the Data to be
          freed.

DESCRIPTION

  This function frees the data specified by Value and Value->Data.
  CertOrCrlOid indicates the type of the data in Value.

  This function should be used only to free CSSM_DATA values returned
  from calls CSSM_CL_CertGetFirstFieldValue(),
  CSSM_CL_CertGetNextFieldValue(), CSSM_CL_CertGetFirstCachedFieldValue(),
  CSSM_CL_CertGetNextCachedFieldValue(), CSSM_CL_CrlGetFirstFieldValue(),
  CSSM_CL_CrlGetNextFieldValue(), CSSM_CL_CrlGetFirstCachedFieldValue(),
  CSSM_CL_CrlGetNextCachedFieldValue(), or their CLI SPI equivalents.

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_TAG

SEE ALSO

  Intel CDSA Application Developer's Guide (see CDSA)