FSDK.PDF2Md Class Reference

Static Public Member Functions
static	ConvertToMarkdown (src_pdf_file_path, src_file_password, saved_md_path, saved_image_dir_name, setting_data)
	Convert a PDF format file to a Markdown file. More...
static	GetVersion ()
	Get the version of Foxit PDF Conversion SDK. More...
static	Initialize (library_path)
	Initialize the PDF2Md module by loading the Foxit PDF Conversion SDK library. More...
static	Release ()
	Release the PDF2Md module and unload the Foxit PDF Conversion SDK library. More...

Detailed Description

This class can be used to convert PDF format files to Markdown files. Before using methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FSDK.Library.Initialize with a key including "PDF2Md" module.

See also

FSDK.Library

Member Function Documentation

ConvertToMarkdown()

static FSDK.PDF2Md.ConvertToMarkdown (   src_pdf_file_path,   src_file_password,   saved_md_path,   saved_image_dir_name,   setting_data  )

inlinestatic

Convert a PDF format file to a Markdown file.

Function FSDK.PDF2Md.Initialize must be called successfully before calling this function.

Parameters

[in]	src_pdf_file_path	Path of a PDF format file. This should not be an empty string.
[in]	src_file_password	Password for the input file. Pass an empty string if no password.
[in]	saved_md_path	Path of the saved Markdown file as conversion result. This should not be an empty string.
[in]	saved_image_dir_name	Name of the directory to save extracted images (plain folder name, no path separators). If null or empty, images will be saved to a default directory named <md_basename>_images.
[in]	setting_data	Setting data used for converting. Default value: FSDK.PDF2MdSettingData default values.

Returns

true means success, while false means failure.

GetVersion()

static FSDK.PDF2Md.GetVersion ( )

inlinestatic

Get the version of Foxit PDF Conversion SDK.

This function should be called after FSDK.PDF2Md.Initialize has been called successfully.

Returns

A string which contains the version information of Foxit PDF Conversion SDK.

Initialize()

static FSDK.PDF2Md.Initialize (   library_path )

inlinestatic

Initialize the PDF2Md module by loading the Foxit PDF Conversion SDK library.

Before using FSDK.PDF2Md.ConvertToMarkdown, please call this function first with the path to the Foxit PDF Conversion SDK library.

Parameters

[in]

library_path

Path to the Foxit PDF Conversion SDK dynamic library. This should not be an empty string.

Returns

None.

Release()

static FSDK.PDF2Md.Release ( )

inlinestatic

Release the PDF2Md module and unload the Foxit PDF Conversion SDK library.

This function should be called after all FSDK.PDF2Md.ConvertToMarkdown calls are finished.

Returns

None.