Foxit PDF Conversion SDK
PDFConversionSDK.Md2PDF Class Reference

Static Public Member Functions

static ConvertFromMarkdownWithPath (src_markdown_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert a Markdown file to a PDF file by path. More...
 
static ConvertFromMarkdownWithStream (src_markdown_reader, src_file_password, saved_pdf_file_stream, setting_data)
 Convert a Markdown file to a PDF file by stream. More...
 

Detailed Description

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

See also
Library

Member Function Documentation

◆ ConvertFromMarkdownWithPath()

static PDFConversionSDK.Md2PDF.ConvertFromMarkdownWithPath (   src_markdown_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
inlinestatic

Convert a Markdown file to a PDF file by path.

Parameters
[in]src_markdown_file_pathPath of a Markdown file. This should not be an empty string.
[in]src_file_password(Reserved) Password for the input Markdown file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]setting_dataA PDFConversionSDK.Md2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "MD2PDF" is not defined in the license information which is used in function Library.Initialize, that means user has no right in using this function and this function will throw exception PDFConversionSDK.e_ErrNoMD2PDFModuleRight.

◆ ConvertFromMarkdownWithStream()

static PDFConversionSDK.Md2PDF.ConvertFromMarkdownWithStream (   src_markdown_reader,
  src_file_password,
  saved_pdf_file_stream,
  setting_data 
)
inlinestatic

Convert a Markdown file to a PDF file by stream.

Parameters
[in]src_markdown_readerA ReaderCallback object which is implemented by user to load a Markdown document. It should not be NULL.
[in]src_file_password(Reserved) Password for the input Markdown file. If no password is needed for the file, please pass an empty string.
[in]saved_pdf_file_streamA StreamCallback object which is implemented by user to read the contents of the converted PDF file. It should not be NULL.
[in]setting_dataA PDFConversionSDK.Md2PDFSettingData object which is used for converting.
Returns
true means success, while false means failure.
Note
If module "MD2PDF" is not defined in the license information which is used in function Library.Initialize, that means user has no right in using this function and this function will throw exception PDFConversionSDK.e_ErrNoMD2PDFModuleRight.