fpExportHTMLToFile()
Creates a HTML representation of the input file and exports it to a file.
To use this function, you must copy the binaries provided in the InstallDir/Platform/html
directory into the bin
directory. By default, these binaries are omitted to reduce the size of the bin
directory if you do not use this function.
Syntax
KVErrorCode(pascal* fpExportHTMLToFile)( KVDocument pDocument, const char* szOutputFile);
Arguments
pDocument
|
A |
szOutputFile
|
A pointer to a string that contains the path of the output file. On Windows, the path must be encoded in the local Windows code page. |
Returns
- If the call is successful, the return value is
KVError_Success
. - If the call is unsuccessful, the return value is an error code that indicates the problem.
Discussion
-
This method might create a number of auxiliary files (other HTML files, images, or subdirectories) in the same folder as the output file.
-
To view the HTML results correctly, you must have javascript enabled.
-
Unlike fpFilterToFile(),
fpExportHTMLToFile
operates recursively on containers and mail files. OpenText recommends that you run it on the top level file. -
This method supports only documents that you create by using fpOpenDocumentFromFile(). Documents created through fpOpenDocumentFromStream() return
KVError_InvalidArgs
. -
The HTML output does not include all content that is present in the Filter output such as headers and footers.
-
This feature is licensed differently to other functions.