KeyView 24.4
KeyView Filter SDK C Programming Guide

# fpFilterFile()

This function filters text from an input file to an output file.

DEPRECATED: The `fpFilterFile()` function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a `KVDocument` to represent each document, and use fpFilter() or fpFilterToFile() instead.

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

## Syntax

    KVErrorCode pascal fpFilterFile(
        KVFilterSession   session,
        char             *szInputFile,
        char             *szOutputFile,
        KVSummaryInfoEx  *pSummaryInfo );

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().
`szInputFile` | A pointer to the input file.
`szOutputFile` | A pointer to the output file.
`pSummaryInfo` | This argument is reserved. It must be `NULL`.

## Returns

The return value is an error code. See KVErrorCode.

## Discussion

- On Windows, `szInputFile` must be in the local Windows code page.

## Example

    error = (int)(*pFilterInterface->fpFilterFile)( pFilter, srcFile, outFile, NULL );

Copyright 1997-2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.4

Topic Title: fpFilterFile()