NAME

CSSM_DL_DbGetRecordParsingFunctions

SYNOPSIS

CSSM_DB_RECORD_PARSING_FNTABLE_PTR CSSMAPI
CSSM_DL_DbGetRecordParsingFunctions
    (CSSM_DL_HANDLE DLHandle,
    const char* DbName,
    const CSSM_DB_RECORDTYPE RecordType)

DESCRIPTION

This function gets the records parsing function table, that operates on records of the specified type, in the specified data store. Three record parsing functions can be returned in the table. The functions can be implemented to parse multiple record types. In this case, multiple calls to DbGetRecordParsingFunctions must be made, once for each record type whose parsing functions are required by the caller. The DL module uses these functions to parse the opaque data object stored in a data store record. If no parsing function table has been set for a given record type, then a NULL value is returned.

PARAMETERS

DLHandle (input)

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

DbName (input)

The name of the data store with which the parsing functions are associated.

RecordType (input)

The record type whose parsing functions are requested by the caller.

RETURN VALUE

A function table for the parsing function appropriate to the specified record type. When CSSM_NULL is returned, either no function table has been set for the specified record type or an error has occurred. Use CSSM_GetError to obtain the error code and determine the reason for the NULL result.

ERRORS

CSSM_DL_INVALID_DL_HANDLE

Invalid DL handle.

CSSM_DL_INVALID_DB_NAME

Invalid DB name.

CSSM_DL_MEMORY_ERROR

Error allocating memory.

SEE ALSO

CSSM_DL_SetRecordParsingFunctions