foxit::addon::conversion::pdf2md::PDF2Md Class Reference

Inherits Object.

Static Public Member Functions
static bool	ConvertToMarkdown (const wchar_t *src_pdf_file_path, const wchar_t *src_file_password, const wchar_t *saved_md_path, const wchar_t *saved_image_dir_name=0, const PDF2MdSettingData &setting_data=PDF2MdSettingData())
	Convert a PDF format file to a Markdown file. More...
static String	GetVersion ()
	Get the version of Foxit PDF Conversion SDK. More...
static void	Initialize (const wchar_t *library_path)
	Initialize the PDF2Md module by loading the Foxit PDF Conversion SDK library. More...
static void	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.

Note

Before using this class, please call PDF2Md::Initialize to load the Foxit PDF Conversion SDK library. After all conversions are done, call PDF2Md::Release to unload the library.

Member Function Documentation

ConvertToMarkdown()

static bool foxit::addon::conversion::pdf2md::PDF2Md::ConvertToMarkdown ( const wchar_t *  src_pdf_file_path, const wchar_t *  src_file_password, const wchar_t *  saved_md_path, const wchar_t *  saved_image_dir_name = 0, const PDF2MdSettingData &  setting_data = PDF2MdSettingData()  )

static

Convert a PDF format file to a Markdown file.

Function 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, placed next to the output Markdown file. Must be a plain folder name without path separators (e.g. "my_images"). If NULL or empty, images will be saved to a default directory named <md_basename>_images next to the output Markdown file.
[in]	setting_data	A PDF2MdSettingData object which is used for converting. Default value: PDF2MdSettingData default values.

Returns

true means success, while false means failure.

GetVersion()

static String foxit::addon::conversion::pdf2md::PDF2Md::GetVersion ( )

static

Get the version of Foxit PDF Conversion SDK.

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

Returns

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

Initialize()

static void foxit::addon::conversion::pdf2md::PDF2Md::Initialize ( const wchar_t *  library_path )

static

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

Before using PDF2Md::ConvertToMarkdown, please call this function first with the path to the Foxit PDF Conversion SDK library. Function common::Library::Initialize must already have been called successfully with a key including "PDF2Md" module right.

Parameters

[in]

library_path

Path to the Foxit PDF Conversion SDK dynamic library (e.g. "fpdfconversionsdk_win64.dll" on Windows, "libfpdfconversionsdk.so" on Linux). This should not be an empty string.

Returns

None.

Release()

static void foxit::addon::conversion::pdf2md::PDF2Md::Release ( )

static

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

This function should be called after all PDF2Md::ConvertToMarkdown calls are finished. It must be called after PDF2Md::Initialize has been called successfully.

Returns

None.