fpCanFilterFile()

This function determines whether a file's format is supported by KeyView. The supported formats are listed in Document Readers.

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

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

Syntax

KVErrorCode pascal fpCanFilterFile( KVFilterSession session, char *szFile );

Arguments

session

A KeyView Filter session that you initialized by calling fpInit().

szFile A pointer to a string that contains the path of the input file. On Windows this must be encoded in the local Windows code page.

Returns

  • If the file format is supported, the return value is KVERR_Success.
  • If the file format is not supported, the return value is an error code.