HP OpenVMS Systems Documentation

Content starts here
HP Open Source Security for OpenVMS Volume 1: Common Data Security Architecture > CDSA API Functions

CL_CrlGetNextCachedFieldValue

  Table of Contents

  Glossary

  Index

NAME

CSSM_CL_CrlGetNextCachedFieldValue — Get the value of the next cached CRL field (CDSA)

SYNOPSIS

# include <cssm.h>
API:
CSSM_RETURN CSSMAPI CSSM_CL_CrlGetNextCachedFieldValue
(CSSM_CL_HANDLE CLHandle,
CSSM_HANDLE ResultsHandle,
CSSM_DATA_PTR *FieldValue)
SPI:
CSSM_RETURN CSSMCLI CL_CrlGetNextCachedFieldValue
(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 add-in Certificate Library module used to perform this function.

ResultsHandle (input)
  

The handle that identifies the results of a CRL query.

FieldValue (output)
  

A pointer to the structure containing the value of the requested field. The structure and the field at I "(*FiledValue)->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 CRL field, when that field occurs multiple times in a CRL. CRLs with repeated fields (such as revocation records) have multiple field values corresponding to a single OID. A call to the function CSSM_CL_CrlGetFirstCachedFieldValue() (CSSM API), or CL_CrlGetFirstCachedFieldValue() (CL SPI), initiates the process and returns a ResultsHandle identifying the size and values contained in the result set. The CSSM_CL_CrlGetNextCachedFieldValue() (CSSM API), or CL_CrlGetNextCachedFieldValue() (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.

The result set selected by CSSM_CL_CrlGetFirstCachedFieldValue() (CSSM API), or CL_CrlGetFirstCachedFieldValue() (CL SPI), and identified by ResultsHandle can reference CRL fields repeated across multiple revocation records or within one revocation record. The scope of the scan was set by an optional CrlRecordIndex input to the function CSSM_CL_CrlGetFirstCachedFieldValue() (CSSM API), or CL_CrlGetFirstCachedFieldValue() (CL SPI). If the record index was specified, then the results set is the revocation record identified by the index. If no record index was specified, then the results set can include repeated fields from multiple revocation records in a CRL.

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

SEE ALSO

Books

Intel CDSA Application Developer's Guide

Online Help

Functions for the CSSM API:

CSSM_CL_CrlGetFirstCachedFieldValue, CSSM_CL_CrlAbortQuery, CSSM_CL_IsCertInCachedCrl, CSSM_CL_CrlCache, CSSM_CL_CrlAbortCache, CSSM_CL_FreeFieldValue

Functions for the CLI SPI:

CL_CrlGetFirstCachedFieldValue, CL_CrlAbortQuery, CL_IsCertInCachedCrl, CL_CrlCache, CL_CrlAbortCache, CL_FreeFieldValue