Foxit PDF SDK
FSDK.Md2PDF Class Reference

Static Public Member Functions

static ConvertFromMarkdown (src_markdown_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert a Markdown format file to a PDF file. More...
 
static GetVersion ()
 Get the version of Foxit PDF Conversion SDK. More...
 
static Initialize (library_path)
 Initialize the Md2PDF module by loading the Foxit PDF Conversion SDK library. More...
 
static Release ()
 Release the Md2PDF module and unload the Foxit PDF Conversion SDK library. More...
 

Detailed Description

This class can be used to convert Markdown format files to PDF 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 "Md2PDF" module.

See also
FSDK.Library

Member Function Documentation

◆ ConvertFromMarkdown()

static FSDK.Md2PDF.ConvertFromMarkdown (   src_markdown_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
inlinestatic

Convert a Markdown format file to a PDF file.

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

Parameters
[in]src_markdown_file_pathPath of a Markdown format file. This should not be an empty string.
[in]src_file_password(Reserved) Password for the input 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_dataSetting data used for converting. Default value: FSDK.Md2PDFSettingData default values.
Returns
true means success, while false means failure.

◆ GetVersion()

static FSDK.Md2PDF.GetVersion ( )
inlinestatic

Get the version of Foxit PDF Conversion SDK.

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

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

◆ Initialize()

static FSDK.Md2PDF.Initialize (   library_path)
inlinestatic

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

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

Parameters
[in]library_pathPath 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 FSDK.Md2PDF.Release ( )
inlinestatic

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

This function should be called after all FSDK.Md2PDF.ConvertFromMarkdown calls are finished.

Returns
None.