KeyView 24.1

# KVStreamInfo

This structure defines a document's character set and format. It is initialized by calling `fpGetStreamInfo()`. See fpGetStreamInfo().

    typedef struct tag_KVStreamInfo
    {
        KVCharSet    charset;
        ADDOCINFO    adInfo;
    }
    KVStreamInfo;

## Member Descriptions

`charset` | The character set of the source document, if that information is ascertainable. The available character sets are enumerated in `KVCharSet` in `kvcharset.h`. See Convert Character Sets.
`adInfo` | The file class, major format, and version of the source document. A pointer to the `ADDOCINFO` structure. The structure of `ADDOCINFO` is defined in `adinfo.h`. See ADDOCINFO. `adInfo.eClass` represents the class of the source document, as defined by the `ENdocClass` enumerated type. `adInfo.eFormat` represents the format of the source document, as defined by the `ENdocFmt` enumerated type. `adInfo.lVersion` represents the version number of the file format. The number is multiplied by 1000. For example, 1.02 is represented by 1020. `adInfo.ulAttributes` represents other attributes of the document as defined by the `ENdocAttributes` enumerated type.

## Discussion

When format detection is enhanced in future releases, new format IDs might be added to the `ENdocFmt` enumerated type. When you use this type, your code should ensure binary compatibility with future releases. For example, if you use an array to access format information based on a format ID, your code should check the format ID is less than `Max_Fmt` before accessing the data. This ensures that new format codes are detected when you add KeyView binary files from new releases to your existing installation.

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