KeyView 24.4
KeyView Filter SDK C Programming Guide

# Introduction

The C sample programs demonstrate how to use the C implementation of the Filter API. The sample code is intended to provide a starting point for your own applications or to be used for reference purposes.

The following C sample programs are provided:

- tstxtract
- filter

The source code and makefile (`program_name_platform.mak`) for the programs are in the directory `install\samples\program_name`, where `install` is the path of the Filter installation directory, and `program_name` is the name of the sample program.

Before the sample programs can be compiled, you must replace the parameter `YOUR_KEYVIEW_LICENSE` in the `fpInit()` function call with your license information.

To compile the sample programs, use the makefile provided for the appropriate platform. Make sure that the Filter `include` directory is specified in the include path of the project. After the executable is compiled and built, you must place it in the same directory as the Filter libraries.

NOTE: Compiled binaries are provided for some of the sample programs, in the `PLATFORM/test` folder. To use these sample programs, you must first copy them into the `bin` folder. The sample programs have an embedded trial license, which expires approximately five months after release. If you set the environment variable `KV_SAMPLE_PROGRAM_LICENSE_FROM_FILEPATH` to a file path, the sample program reads your license from the specified file. This allows you to use the program after the embedded trial license has expired, and to test or troubleshoot with your own license.

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: Introduction