KeyView 24.1

# Introduction

The `fpConvertStream()` and `KV` `XML` `ConvertFile()` functions enable you to specify a callback function. A callback function controls the conversion while it is in progress. For example, you can specify a callback function to report progress during the conversion.

To use the API callback functions, declare one or more instances of the `KV` `XML` `Callbacks` structure. Each member of this instance can then be initialized by assigning a function pointer to the application-defined callback functions, cast to the appropriate function prototype. Each instance of `KV` `XML` `Callbacks` can define unique callback functions. Alternatively, the functions can be common to all instances of `KV` `XML` `Callbacks`; these functions take appropriate action, depending on the value of the pointer `pCallingContext`.

The second parameter (`pCallingContext)` of the call to `fpConvertStream()` and `KV` `XML` `ConvertFile()` provides a void pointer used to identify the context of this call. If more than one call to `fpConvertStream()` or `KV` `XML` `ConvertFile()` is made within a single application, any resulting callbacks are identified by the first parameter of the callback function. This enables the callback function to take any appropriate action, depending on which calling context is returned.

The seventh parameter (`pCallbacks`) of the call to `fpConvertStream()` and `KV` `XML` `ConvertFile()` must be set to the address of the `KV` `XML` `Callbacks` structure to be used for this call.

For sample code, see the sample program `xml` `callback.c`. It creates an XML stream and demonstrates the use of the callback functions.

Copyright 1997-2023 Open Text
Version 24.1 | Last updated December 2023

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.1

Topic Title: Introduction