KeyView 24.4
KeyView Filter SDK C Programming Guide

# fpGetDocInfoFile()

This function gets the following format information for a file and populates the `ADDOCINFO` structure:

- File format
- File class
- Major version
- Other attributes

The possible values are defined in `adinfo.h`.

DEPRECATED: The `fpGetDocInfoFile()` function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a `KVDocument` to represent each document, and use fpGetDocInfo() instead.

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

## Syntax

    BOOL pascal fpGetDocInfoFile(
        KVFilterSession  session,
        char            *szFile,
        ADDOCINFO       *pADDocInfo );

## Arguments

`session` | A KeyView Filter session that you initialized by calling fpInit().
`szFile` | A pointer to the input file.
`pADDOCINFO` | The format, file class, and version of the source document. A pointer to the ADDOCINFO structure. The structure of `ADDOCINFO` is defined in `adinfo.h`.

## Returns

- If the format information is extracted, the return value for this function is `TRUE`.
- If the format information is not extracted, the return value is `FALSE`. You can find out what went wrong by calling fpGetKvErrorCodeEx().

## Discussion

- On Windows, `szFile` must be in the local Windows code page.

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: fpGetDocInfoFile()