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
.
An extended error code is set in pContext
if an invalid input file is provided. You can retrieve the error code by using fpGetKvErrorCodeEx().
Syntax
BOOL pascal fpGetDocInfoFile( void *pContext, char *szFile, ADDOCINFO *pADDocInfo );
Arguments
pContext
|
A pointer returned from fpInit() or fpInitWithLicenseData(). |
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
. IfFALSE
is returned, you can retrieve the extended error code by using fpGetKvErrorCodeEx().
Discussion
-
This function runs in process or out of process. See The Filter Process Model.
-
On Windows,
szFile
must be in the local Windows code page.