NAME

CL_CertGetFirstFieldValue

SYNOPSIS

CSSM_DATA_PTR CSSMCLI CL_CertGetFirstFieldValue
    (CSSM_CL_HANDLE CLHandle,
    const CSSM_DATA_PTR Cert,
    const CSSM_OID_PTR CertField,
    CSSM_HANDLE_PTR ResultsHandle,
    uint32 *NumberOfMatchedFields)

DESCRIPTION

This function returns the value of the designated certificate field. If more than one field matches the CertField 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.

Cert (input)

A pointer to the CSSM_DATA structure containing the certificate.

CertField (input)

A pointer to an object identifier that identifies the field value to be extracted from the Cert.

ResultsHandle (output)

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

NumberOfMatchedFields (output)

The number of fields that match the CertField OID.

RETURN VALUE

A pointer to the CSSM_DATA structure containing the value of the requested field. If the pointer is NULL, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_CL_INVALID_CL_HANDLE

Invalid Certificate Library Handle.

CSSM_CL_INVALID_DATA_POINTER

Invalid pointer input.

CSSM_CL_UNKNOWN_FORMAT

Unrecognized certificate format.

CSSM_CL_UNKNOWN_TAG

Unknown field tag.

CSSM_CL_MEMORY_ERROR

Not enough memory.

CSSM_CL_NO_FIELD_VALUES

No field values for this results handle.

CSSM_CL_CERT_GET_FIELD_VALUE_FAIL

Unable to get field value.

SEE ALSO

CL_CertGetNextFieldValue, CL_CertAbortQuery,
CL_CertGetAllFields, CL_CertDescribeFormat