CL_CertGetNextFieldValue

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

CL_CertGetNextCachedFieldValue

CL_CertGroupFromVerifiedBundle

CL_CertGetNextFieldValue

Library
Description
Errors

Parameters
Return Value
See Also

NAME

CL_CertGetNextFieldValue: CSSM_CL_CertGetNextFieldValue - Return the value of a certificate field (CDSA)

SYNOPSIS

# include <cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_CL_CertGetNextFieldValue
(CSSM_CL_HANDLE CLHandle,
CSSM_HANDLE ResultsHandle,
CSSM_DATA_PTR *Value)
SPI:
CSSM_RETURN CSSMCLI CL_CertGetNextFieldValue
(CSSM_CL_HANDLE CLHandle,
CSSM_HANDLE ResultsHandle,
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.
`ResultsHandle` (input)
		The handle that identifies the results of a certificate query.
`Value` (output)
		A pointer to the structure containing the value of the requested field. The structure and the field at I "(Value)->Data" are allocated by the service provider. The `CSSM_CL_FreeFieldValue()` (CSSM API) or `CL_FreeFieldValue()` (CL SPI), function can be used to deallocate `Value` and `(*Value)->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_CertGetFirstFieldValue() (CSSM API), or CL_CertGetFirstFieldValue() (CL SPI), returns a results handle identifying the size and values contained in the result set. The CSSM_CL_CertGetNextFieldValue() (CSSM API), or CL_CertGetNextFieldValue() (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.

CSSMERR_CL_INVALID_RESULTS_HANDLE
CSSMERR_CL_NO_FIELD_VALUES