fpGetExtractInterface()

Call this function to obtain the file extraction functions. When you call this function, it assigns the function pointers in the KVExtractInterface structure so that you can use the functions described in File Extraction API Functions.

Syntax

KVErrorCode (pascal* fpGetExtractInterface)(
        KVFilterSession session,
        KVExtractInterface pExtractInterface);

Arguments

session

A Filter session that you initialized by calling fpInit().

pExtractInterface A KVExtractInterface structure. Before you initialize the KVExtractInterface structure, use the macro KVStructInit to initialize the KVStructHead structure.

Returns

  • If the call is successful, the return value is KVError_Success.
  • If the call is not successful, the return value is an error code that indicates the problem.

Lifetimes and Memory Management

Destroy the KVFilterSession only after you no longer need to call the extraction functions.

Discussion

  • You can get only one extraction interface for each Filter session.

  • The KVFilterSession that you pass in must be the same KVFilterSession that you pass into the File Extraction API functions returned in KVExtractInterface.

Example

KVStructInit(&extractInterface);
error = filterInterface->fpGetExtractInterface(session, &extractInterface);