NAME

CSSM_DL_DbSetRecordParsingFunctions

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_DL_DbSetRecordParsingFunctions
    (CSSM_DL_HANDLE DLHandle,
    const char* DbName,
    const CSSM_DB_RECORDTYPE RecordType,
    const CSSM_DB_RECORD_PARSING_FNTABLE_PTR FunctionTable)

DESCRIPTION

This function sets the records parsing function table, overriding the default parsing module, for records of the specified type, in the specified data store. Three record parsing functions can be specified in the table. The functions can be implemented to parse multiple record types. In this case, multiple calls to DbSetRecordParsingFunctions must be made, once for each record type that should be parsed using these functions. 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 the default parsing module is invoked for that record type.

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 to associate the parsing functions.

RecordType (input)

One of the record types parsed by the functions specified in the function table.

FunctionTable (input)

The function table referencing the three parsing functions to be used with the data store specified by DbName.

RETURN VALUE

A CSSM_OK return value signifies that the function completed successfully. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.

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_GetRecordParsingFunctions