fpFilter()
Filters text from a document.
Syntax
KVErrorCode (pascal* fpFilter)(
KVDocument pDocument,
KVFilterOutput* pFilterOutput);
Arguments
pDocument
|
A |
pFilterOutput
|
A pointer to an existing KVFilterOutput structure. On success,
fpFilter populates this structure with the filtered text. |
Returns
The return value is an error code.
- If the call is successful, the return value is
KVError_Successand the filtered text is stored inpFilterOutput. - If the call is unsuccessful, the return value is an error code that indicates the problem.
Lifetimes and Memory Management
- After each successful call to
fpFilter, when you no longer require the data in thepFilterOutputstructure, call fpFreeFilterOutput to free the memory allocated by this function. Call fpFreeFilterOutput only iffpFilterreturnsKVError_Success. You must call fpFreeFilterOutput before you call fpShutdown().
Discussion
-
This function outputs filtered text in chunks. The first call to
fpFilter()outputs the first chunk of filtered text topFilterOutput. CallfpFilter()again to output the next chunk, and repeat this process to obtain all of the filtered text from the document. The final chunk does not contain any text, such thatpFilterOutput->cbText == 0. Do not callfpFilter()again after this.IMPORTANT: Do not call any Filter API functions between calls to
fpFilter(), because doing so might prevent filtering from resuming correctly. -
If
fpFilterreturns an error, filtering failed and you must not callfpFilter()again for thispDocumentbecause it will not obtain any more text.