KVXMLConvertFile()

This function is called directly and converts a source file to an output file.

Syntax

BOOL pascal KVXMLConvertFile  (
    void                    *pContext,
    void                    *pCallingContext,
    char                    *pInFileName,
    char                    *pOutFileName,
    KVXMLTemplate           *pTemplates,
    KVXMLOptions            *pOptions,
    KVXMLTOCOptions         *pTOCCreateOptions,
    KVXMLCallbacks          *pCallbacks,
    BOOL                     bIndex,
    KVErrorCode             *pError)

Arguments

pContext

A pointer to a KeyView Export session that you initialized by calling fpInit().

pCallingContext

A pointer passed back to the callback functions.

pInFileName

A pointer to the input file.

pOutFileName

A pointer to the output file.

pTemplates

A pointer to the data structure KVXMLTemplate data structure. It defines the overall structure of the output. Individual elements within the structure define the markup written at specific points in the output stream. See KVXMLTemplate.

If this pointer is NULL, the default values for the structure are used.

pOptions

A pointer to the data structure KVXMLOptions. It defines the options that control the markup written in response to the general style and attributes (font, color, and so on) of the document. See KVXMLOptions.

If this pointer is NULL, the default values for the structure are used.

pTOCCreateOptions

A pointer to the KVXMLTOCOptions data structure. It specifies whether a heading is included in the table of contents. See KVXMLTOCOptions.

If this pointer is NULL, the default values for the structure are used.

pCallbacks

A pointer to the KVXMLCallbacks data structure. It is a structure of functions that Export calls for specific, user-defined purposes. See KVXMLCallbacks.

If callbacks are not used, this can be NULL.

bIndex

Set bIndex to TRUE to generate output with minimal markup and without images. Because the generated output is minimized to textual content, it is suitable for an indexing engine. If bIndex is set to FALSE, embedded images in a document are regenerated as separate files and stored in the output directory.

This can also be set through the bNoPictures member in the template files.

pError

A pointer to an error code if the call to KVXMLConvertFile() fails.

Returns

  • If the call is successful, the return value is TRUE.

  • If the call is unsuccessful, the return value is FALSE.

Discussion

  • Only pContext, pInFileName, pOutFileName, and bIndex are required. All other pointers should be NULL when they are not set.

  • If pCallbacks is NULL, pOptions->pszDefaultOutputDirectory must be valid, except when you set bIndex to TRUE.

  • This function runs in-process or out-of-process. See Convert Files Out-of-Process.

  • When converting out-of-process, this function must be called after the call to KVXMLStartOOPSession() and before the call to KVXMLEndOOPSession(). See KVXMLStartOOPSession() and KVXMLEndOOPSession().

  • When converting out-of-process, the values for the KVXMLTemplate, KVXMLOptions, and KVXMLTOCOptions structures should be set to NULL. These structures are already passed in the call to KVXMLStartOOPSession(). See KVXMLStartOOPSession().

  • On Windows, pInFileName and pOutFileName must be in the local Windows code page.

Example

if(!(*KVXMLInt.KVXMLConvertFile)(
             pKVXML,         /* Pointer returned by fpInit()   */
             NULL,           /* Pointer for callback functions */
             &InputFile,     /* Input file                     */
             &OutputFile,    /* Output file                    */
             &XMLTemplates,  /* Markup and related variables  */
             &XMLOptions,    /* Options                        */
             NULL,           /* TOC options                    */
             NULL,           /* A pointer to callback functions  */
             FALSE,          /* Index mode                     */
             &error))        /* Error return value             */
{
   printf("Error converting %s to XML %d\n", argv[i - 1], error);
}
else
{
   printf("Conversion of %s to XML completed.\n\n", argv[i - 1]);
}