fpFreeFilterOutput()

This function frees the memory allocated in the pFilterOutput argument of fpFilter() or fpFilterStream().

Syntax

BOOL pascal fpFreeFilterOutput(
    KVFilterSession session,
    KVFilterOutput *pFilterOutput);

Arguments

session

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

pFilterOutput A pointer to the KVFilterOutput structure.

Returns

If the call is successful, the return value is TRUE. If the call is unsuccessful, the return value is FALSE.

Discussion

Call this function after each chunk of filter output is returned by fpFilterStream, after the data is no longer required, before calling fpFilterStream again. It is not necessary to call this function for the final call to fpFilterStream (when pFilterOutput->cbText == 0).

This function does not free pFilterOutput itself.