TP_CertGetAllTemplateFields

NAME

CSSM_TP_CertGetAllTemplateFields — Get CertTemplate field values (CDSA)

SYNOPSIS

# include <cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_TP_CertGetAllTemplateFields
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_DATA *CertTemplate,
uint32 *NumberOfFields,
CSSM_FIELD_PTR *CertFields)
SPI:
CSSM_RETURN CSSMTPI TP_CertGetAllTemplateFields
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_DATA *CertTemplate,
uint32 *NumberOfFields,
CSSM_FIELD_PTR *CertFields)

LIBRARY

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

PARAMETERS

`TPHandle` (`input`)		The handle that describes the add-in trust policy module used to perform this function.
`CLHandle` (`input`)		The handle that describes the certificate library module used to perform this function.
`CertTemplate` (`input`)
		A pointer to the CSSM_DATA structure containing the packed, encoded certificate template.
`NumberOfFields` (`output`)
		The length of the output array of fields.
`CertFields` (`output`)
		A pointer to an array of CSSM_FIELD structures which contains the OIDs and values of the fields of the input certificate template.

DESCRIPTION

This function extracts and returns all field values from CertTemplate. The CertTemplate parameter is an unsigned certificate template in the format supported by the TP. Fields are returned as a set of OID-value pairs. The OID identifies the TP certificate template field and the data format of the value extracted from that field. The Trust Policy module defines and uses a preferred data format for returning field values from this function. Memory for the CertFields output is allocated by the service provider using the calling application's memory management routines. The application must deallocate the memory, by calling CSSM_CL_FreeFields() (CSSM API), or CL_FreeFields() (TP SPI).

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_TP_INVALID_CL_HANDLE
CSSMERR_TP_INVALID_FIELD_POINTER
CSSMERR_TP_UNKNOWN_FORMAT

TP_CertGetAllTemplateFields

» Table of Contents

» Glossary

» Index