Library /sys$common/syshlp/helplib.hlb  —  CDSA  CDSA_API, CL CertGetNextCachedFieldValue
 NAME

   CL_CertGetNextCachedFieldValue,
   CSSM_CL_CertGetNextCachedFieldValue - Return the value of a certificate
                                         field (CDSA)

 SYNOPSIS

   # include <cssm.h>

        API:
        CSSM_RETURN CSSMAPI CSSM_CL_CertGetNextCachedFieldValue
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE ResultsHandle,
        CSSM_DATA_PTR *FieldValue)
        SPI:
        CSSM_RETURN CSSMAPI CSSM_CL_CertGetNextCachedFieldValue
        (CSSM_CL_HANDLE CLHandle,
        CSSM_HANDLE ResultsHandle,
        CSSM_DATA_PTR *FieldValue)

 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.

   ResultsHandle (input)
           The handle that identifies the results of a certificate query.

   FieldValue (output)
           A pointer to the structure containing the value of the
           requested field. The structure and the field at I
           "(*FieldValue)->Data" are allocated by the service provider.
           The CSSM_CL_FreeFieldValue() (CSSM API), or CL_FreeFieldValue()
           (CL SPI) function can be used to deallocate *FieldValue and
           (*FieldValue)->Data.

 DESCRIPTION

   This function returns the value of a certificate field, when that
   field occurs multiple times in a certificate. Certificates with
   repeated fields (such as multiple signatures) have multiple field
   values corresponding to a single OID. A call to the function
   CSSM_CL_CertGetFirstCachedFieldValue() (CSSM API), or
   CL_CertGetFirstCachedFieldValue() (CL SPI), returns a ResultsHandle
   identifying the size and values contained in the result set.  The
   CSSM_CL_CertGetNextCachedFieldValue() (CSSMAPI), or
   CL_CertGetNextCachedFieldValue() (CL SPI), function can be called
   repeatedly to obtain these values, one at a time. The result set does
   not change in size or value between calls to this function.

 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_RESULTS_HANDLE
        CSSMERR_CL_NO_FIELD_VALUES

 SEE ALSO

   Books

   Intel CDSA Application Developer's Guide (see CDSA)

   Other Help Topics

   Functions for the CSSM API:

       CSSM_CL_CertGetFirstCachedFieldValue
       CSSM_CL_CertAbortCache
       CSSM_CL_CertAbortQuery
       CSSM_CL_CertGetAllFields
       CSSM_CL_CertDescribeFormat
       CSSM_CL_FreeFieldValue

   Functions for the CLI SPI:

       CL_CertGetFirstCachedFieldValue
       CL_CertAbortCache
       CL_CertAbortQuery
       CL_CertGetAllFields
       CL_CertDescribeFormat
       CL_FreeFieldValue
Close Help