KeyView 23.4

# KVSubFileExtractInfo

This structure contains information about an extracted subfile. It is initialized by calling fpExtractSubFile(). This structure is defined in `kvxtract.h`.

    typedef struct tag_KVSubFileExtractInfo
    {
        KVStructHeader;
        char            *filePath;
        char            *fileName;
        unsigned long    infoFlag;
        ADDOCINFO        docInfo;
    }
    KVSubFileExtractInfoRec, *KVSubFileExtractInfo;

## Member Descriptions

`KVStructHeader` | The KeyView version of the structure. See KVStructHead.
`filePath` | The full path to which the subfile was extracted. If the subfile is embedded in the main file as a link, this is the external path to the subfile. If you output the data to a stream, the extraction path is not returned.
`fileName` | The original path, file name, or path and file name of the subfile. If the subfile is embedded in the main file as a link, this is the external path to the subfile.
`infoFlag` | A bitwise flag that provides additional information about the extracted subfile. The following flags are available: `KVSubFileExtractInfoFlag_NeedsExtraction`—The file might contain subfiles and should be extracted further. `KVSubFileExtractInfoFlag_FileCreated`—``The file was created on disk. `KVSubFileExtractInfoFlag_CharsetConverted`—The subfile’s character set was converted. `KVSubFileExtractInfoFlag_External`—The subfile is embedded in the main file as a link and is stored externally. For example, the subfile might be an object that was embedded in a Word document using "Link to File," or an attachment that is referenced in an MBX message. This type of file cannot be extracted. You must write code to access the subfile based on the path in the member `filePath` or `fileName`. `KVSubFileExtractInfoFlag_FolderCreated`—A folder was created. `KVSubFileExtractInfoFlag_NonFormattedBodyExtracted`—Indicates that a plain text version of the message was extracted due to an error extracting the formatted version of the message.
`docInfo` | The file’s major format (such as Microsoft Word or Corel Presentation), as defined by the structure `ADDOCINFO`. See ADDOCINFO. If you output the data to a stream, the file format is not returned.

Copyright 2016-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: KVSubFileExtractInfo