fpGetFileInfo()

This function returns information about a file such as its format and character set.

Syntax

KVPDFState pascal fpGetFileInfo(
    const KVPDFContext context,
    const char* const pszInFileName,
    KVDocInfo* const pDocInfo);

Arguments

Context

A context value obtained by using fpInit().

pszInFileName

A null-terminated C string that contains the path of the file to retrieve information about.

pDocInfo A pointer to a KVDocInfo structure to write the file information to.

Returns

  • If the call is successful, a KVPDFState structure with eErrorCode set to KVERR_Success.
  • If the call is unsuccessful, a KVPDFState structure that indicates the reason for the error.

Discussion

  • On Windows systems, specify the paths in the local Windows code page.
  • You must not initialize the KVDocInfo structure by using the KVStructInit() macro.
  • If the call is unsuccessful and returns an error state, the memory that pDocInfo points to has not been modified.
  • On Windows, pszInFileName must be in the local Windows code page.