KeyView 24.4
KeyView Filter SDK C Programming Guide

# KVFilterInitOptions

This structure defines configuration options for a Filter session that you initialize by calling fpInit(). This structure is defined in `kvfiltersettings.h`.

    typedef struct tag_KVFilterInitOptions
    {
        KVStructHeader;

        KVCharSet outputCharSet;
        DWORD dwFlags;
    } KVFilterInitOptions;

## Member Descriptions

`KVStructHeader` | The KeyView version of the structure. See KVStructHead. You must use the macro `KVStructInit` to initialize the `KVStructHead` structure.
`outputCharSet` | The output character set to use when the source character set can be determined from the document or is specified by fpSetSrcCharSet(). The character sets are enumerated in `KVCharSet` in `kvcharset.h`. DEPRECATED: Output character encodings other than UTF-8 and UTF-16 are deprecated in KeyView version 24.4. OpenText recommends that you use UTF-8 or UTF-16, which is output in Little Endian byte order. Support for other character encodings is currently available but might be removed in a future release.
`dwFlags` | Instructions on how to process a file or stream. See the following table for more information.

## Flags for dwFlags

`KVF_CONTENTACCESS` | Reserved for internal use.
`KVF_OUTOFPROCESS` | Enables out-of-process filtering. This is enabled by default. See Run Filter In Process.
`KVF_INPROCESS` | Enables in-process filtering. See Run Filter In Process.
`KVF_HEADERFOOTERTAGS` | Puts tags around header and footer data.
`KVF_HEADERFOOTER` | Extract headers and footers.
`KVF_UNICODEMSBLSB` | Uses the byte order for Big Endian systems (MSBLSB) for Unicode text. MSBLSB is the "Most Significant Byte Least Significant Byte." DEPRECATED: This option is deprecated in KeyView version 24.4 and later. KeyView now supports outputting text to only UTF-8 and UTF-16, in Little Endian format. This option might be removed in future.
`KVF_UNICODELSBMSB` | Uses the byte order for Little Endian systems (LSBMSB) for Unicode text. LSBMSB is the "Least Significant Byte Most Significant Byte." DEPRECATED: This option is deprecated in KeyView version 24.4 and later. KeyView now supports outputting text to only UTF-8 and UTF-16, in Little Endian format. This option might be removed in future.
`KVF_UNICODEMARKER` | Generates the byte order marker for Unicode text.
`KVF_NODEFAULTCHARSETCONVERT` | Prevents default conversion of document character encoding. See Disable Character Encoding Conversion.
`KVF_OOPLOGON` | Enables the out-of-process error log. See Enable or Disable Legacy Out-of-Process Error Logging. DEPRECATED: This option is deprecated in KeyView Filter version 24.1. Use fpSetConfig() to enable logging instead.
`KVF_OOPLOGOFF` | Disables the out-of-process error log. See Enable or Disable Legacy Out-of-Process Error Logging. DEPRECATED: This option is deprecated in KeyView Filter version 24.1. Use fpSetConfig() to disable logging instead.
`KVF_DETECT_OUTOFPROCESS` `KVF_DETECT_INPROCESS` | These flags specify whether file format detection occurs in-process or out-of-process. These flags override the `default_detect_inprocess` parameter in `formats.ini`. If you set neither of these flags, file detection behavior is determined by the `KVF_OUTOFPROCESS` or `KVF_INPROCESS` flags. If you do not set those flags, behavior is determined by `default_detect_inprocess` in `formats.ini`. See Run Filter In Process.

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