KeyView 23.4

# fpConvertStream()

This function converts either a source stream or file to an output stream.

## Syntax

    BOOL pascal fpConvertStream(
        void                *pContext,
        void                *pCallingContext,
        KVInputStream       *pInput,
        KVOutputStream      *pOutput,
        KVHTMLTemplateEx    *pTemplatesEx,
        KVHTMLOptionsEx     *pOptionsEx,
        KVHTMLCallbacksEx   *pCallbacksEx,
        KVHTMLTOCOptions    *pTOCCreateOptions,
        BOOL                 bIndex,
        KVErrorCode         *pError );

## Arguments

`pContext` | A pointer to a KeyView Export session that you initialized by calling fpInit().
`pCallingContext` | A pointer passed back to the callback functions.
`pInput` | A pointer to the developer-assigned instance of `KVInputStream`. The `KVInputStream` structure defines the input stream that contains the source for the conversion. See KVInputStream.
`pOutput` | A pointer to the developer-assigned instance of `KVOutputStream`. The `KVOutputStream` structure defines the output stream to which Export writes the generated HTML. See KVOutputStream.
`pTemplatesEx` | A pointer to the `KVHTMLTemplateEx` data structure. It defines the overall structure of the output. Individual elements within the structure define the markup written at specific points in the output stream. See KVHTMLTemplateEx. If this pointer is `NULL`, the default values for the structure are used.
`pOptionsEx` | A pointer to the KVHTMLOptionsEx data structure. It defines the options that control the markup written in response to the general style and attributes (font, color, and so on) of the document. See KVHTMLOptionsEx. If this pointer is `NULL`, the default values for the structure are used.
`pCallbacksEx` | A pointer to the `KVHTMLCallbacksEx` data structure. It is a structure of functions that Export calls for specific, user-defined purposes. See KVHTMLCallbacksEx. If callbacks are not used, this can be `NULL`.
`pTOCCreateOptions` | A pointer to the `KVHTMLTOCOptions` data structure. It specifies whether a heading is included in the table of contents. See KVHTMLTOCOptions. If this pointer is `NULL`, the default values for the structure are used.
`bIndex` | Set `bIndex` to `TRUE` to generate output with minimal markup and without images. Because the generated output is minimized to textual content, it is suitable for an indexing engine. If you set `bIndex` to `FALSE`, embedded images in a document are regenerated as separate files and stored in the output directory. You can also set this option through the bNoPictures member in the template files.
`pError` | A pointer to an error code if the call to `fpConvertStream()` fails.

## Returns

- If the call is successful, the return value is `TRUE`.

- If the call is unsuccessful, the return value is `FALSE`.

## Discussion

- Only `pContext`, `pInput`, `pOutput`, and `bIndex` are required. All other pointers should be `NULL` when they are not set.

- If `pCallbacksEx` is `NULL`, `pOptionsEx->pszDefaultOutputDirectory` must be valid, except when `bIndex` is set to `TRUE`.

- This function runs in-process or out of process. See Convert Files Out of Process.

- When converting out of process, this function must be called after the call to `KVHTMLStartOOPSession()` and before the call to `KVHTMLEndOOPSession()`. See KVHTMLStartOOPSession() and KVHTMLEndOOPSession().

- When converting out of process, the values for the `KVHTMLTemplateEx`, `KVHTMLOptionsEx`, and `KVHTMLTOCOptions` structures should be set to `NULL`. These structures are already passed in the call to `KVHTMLStartOOPSession()`. See KVHTMLStartOOPSession().

## Example

The following sample code is from the `cnv2html` sample program:

    if(!(*KVHTMLInt.fpConvertStream)(
                 pKVHTML,        /* A pointer returned by fpInit()  */
                 NULL,           /* A pointer for callback functions */
                 &Input,         /* Input stream                   */
                 &Output,        /* Output stream                  */
                 &HTMLTemplates, /* Markup and related variables  */
                 &HTMLOptions,   /* Options                        */
                 NULL,           /* A pointer to callback functions  */
                 NULL,           /* TOC options                    */
                 FALSE,          /* Index mode                     */
                 &error))        /* Error return value             */
    {
       printf("Error converting %s to HTML %d\n", argv[i - 1], error);
    }
    else
    {
       printf("Conversion of %s to HTML completed.\n\n", argv[i - 1]);
    }

Copyright 1997-2023 Open Text
Version 23.4 | Last updated September 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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL KeyView 23.4

Topic Title: fpConvertStream()