NAME

CSSM_CL_CrlGetFirstFieldValue

SYNOPSIS

CSSM_DATA_PTR CSSMAPI CSSM_CL_CrlGetFirstFieldValue
    (CSSM_CL_HANDLE CLHandle,
    const CSSM_DATA_PTR Crl,
    const CSSM_OID_PTR CrlField,
    CSSM_HANDLE_PTR ResultsHandle,
    uint32 *NumberOfMatchedCrls)

DESCRIPTION

This function returns the value of the designated CRL field. If more than one field matches the CrlField OID, the first matching field will be returned. The number of matching fields is an output parameter, as is the ResultsHandle to be used to retrieve the remaining matching fields.

PARAMETERS

CLHandle (input)

The handle that describes the add-in certificate library module used to perform this function.

Crl (input)

A pointer to the CSSM_DATA structure which contains the CRL from which the field is to be retrieved.

CrlField (input)

An object identifier which identifies the field value to be extracted from the Crl.

ResultsHandle (output)

A pointer to the CSSM_HANDLE which should be used to obtain any additional matching fields.

NumberOfMatchedFields (output)

The number of fields which match the CrlField OID.

RETURN VALUE

Returns a pointer to a CSSM_DATA structure containing the first field which matched the CrlField. If the pointer is NULL, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_CL_INVALID_CL_HANDLE

Invalid CL handle.

CSSM_CL_UNKNOWN_TAG

Unrecognized field tag in OID.

CSSM_CL_NO_FIELD_VALUES

No fields match the specified OID.

CSSM_CL_INVALID_CRL_PTR

Invalid CRL pointer.

CSSM_CL_CRL_GET_FIELD_VALUE_FAIL

Unable to get first field value.

SEE ALSO

CSSM_CL_CrlGetNextFieldValue, CSSM_CL_CrlAbortQuery