skip book previous and next navigation links
go up to top of book: HP Open Source Security for OpenVMS Volume 1:... HP Open Source Security for OpenVMS Volume 1:...
go to beginning of reference: API FunctionsAPI Functions
go to previous page: CL_CertAbortCacheCL_CertAbortCache
go to next page: CL_CertCacheCL_CertCache
end of book navigation links


CL_CertAbortQuery
Library
Description
Errors
 Parameters
Return Value
See Also

NAME

CL_CertAbortQuery: CSSM_CL_CertAbortQuery function - Terminate a results handle (CDSA)

SYNOPSIS  

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery(CSSM_CL_HANDLE CLHandle,CSSM_HANDLE ResultsHandle) SPI:CSSM_RETURN CSSMAPI CSSM_CL_CertAbortQuery(CSSM_CL_HANDLE CLHandle,CSSM_HANDLE ResultsHandle)


return to top LIBRARY  

Common Security Services Manager library (cdsa$incssm300_shr.exe)


return to top PARAMETERS  

CLHandle (input)
 The handle that describes the add-in certificatelibrary module used to perform this function.
ResultsHandle (input)
 A pointer to the handle that identifies the resultsof a CSSM_CL_GetFieldValue() (CSSM API), or CL_GetFieldValue() (CLI SPI) request.


return to top DESCRIPTION  

This function terminates a results handle used to access multiplecertificate fields identified by a single OID. The ResultsHandle wascreated and returned by CSSM_CL_CertGetFirstFieldValue() (CSSM API), or CL_CertGetFirstFieldValue() (CL SPI), or CSSM_CL_CertGetFirstCachedFieldValue() (CSSM API), or CL_CertGetFirstCachedFieldValue() (CL SPI).

The CL releases all intermediate state information associatedwith the repeating-value query. Once this function has been invoked,the results handle is invalid.

Applications must invoke this function to terminate the ResultsHandle.Using CSSM_CL_CertGetNextFieldValue() (CSSM API), or CL_CertGetNextFieldValue() (CL SPI), or CSSM_CL_CertGetNextCachedFieldValue() (CSSM API), or CL_CertGetNextCachedFieldValue() (CL SPI), to access all of the attributes named by asingle OID does not terminate the ResultsHandle.

This function can be invoked to terminate the results handlewithout accessing all values identified by the single OID.


return to top RETURN VALUE  

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.


return to top ERRORS  

Errors are described in the CDSA Technical Standard.
CSSMERR_CL_INVALID_RESULTS_HANDLE


return to top SEE ALSO  

Books

Intel CDSA Application Developer's Guide

Online Help

Functions for the CSSM API:

CSSM_CL_CertGetFirstFieldValue, CSSM_CL_CertGetNextFieldValue, CSSM_CL_CertGetFirstCachedFieldValue, CSSM_CL_CertGetNextCachedFieldValue

Functions for the CLI SPI:

CL_CertGetFirstFieldValue, CL_CertGetNextFieldValue, CL_CertGetFirstCachedFieldValue, CL_CertGetNextCachedFieldValue


go to previous page: CL_CertAbortCacheCL_CertAbortCache
go to next page: CL_CertCacheCL_CertCache