Foxit PDF Conversion SDK
foxit::conversion::pdf2md::PDF2Md Class Reference
Inheritance diagram for foxit::conversion::pdf2md::PDF2Md:
foxit::Base

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...
 

Additional Inherited Members

- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class can be used to convert PDF format files to Markdown files.

Member Function Documentation

◆ ConvertToMarkdown()

static bool foxit::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.

Parameters
[in]src_pdf_file_pathPath of a PDF format file. This should not be an empty string.
[in]src_file_passwordPassword for the input file. Pass an empty string if no password.
[in]saved_md_pathPath of the saved Markdown file as conversion result. This should not be an empty string.
[in]saved_image_dir_nameName 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"). Passing a path (containing '/', '\' or ':') will throw foxit::e_ErrParam. If NULL or empty, images will be saved to a default directory named <md_basename>_images next to the output Markdown file.
[in]setting_dataA PDF2MDSettingData object for conversion settings. Default: PDF2MDSettingData default values.
Returns
true means success, while false means failure.