ComPDFKit Conversion C++ SDK 3.0.0
API Documentation
compdfkit::base Namespace Reference

Classes

struct  ConvertOptions
 Convert options. More...
 

Enumerations

enum class  OCRLanguage {
  e_UNKNOWN = 0 , e_Chinese , e_ChineseTra , e_English ,
  e_Korean , e_Japanese , e_Latin , e_Devanagari ,
  e_Auto
}
 OCR language. More...
 
enum class  ErrorCode {
  e_ErrSuccess = 0 , e_ErrCancel = 1 , e_ErrFile = 2 , e_ErrPDFPassword = 3 ,
  e_ErrPDFPage = 4 , e_ErrPDFFormat = 5 , e_ErrPDFSecurity = 6 , e_ErrOutOfMemory = 7 ,
  e_ErrIO = 8 , e_ErrCompress = 9 , e_ErrLicenseInvalid = 20 , e_ErrLicenseExpire = 21 ,
  e_ErrLicenseUnsupportedPlatform = 22 , e_ErrLicenseUnsupportedID = 23 , e_ErrLicenseUnsupportedDevice = 24 , e_ErrLicensePermissionDeny = 25 ,
  e_ErrLicenseUninitialized = 26 , e_ErrLicenseIllegalAccess = 27 , e_ErrLicenseFileReadFailed = 28 , e_ErrLicenseOCRPermissionDeny = 29 ,
  e_ErrNoTable = 40 , e_ErrOCRFailure = 41 , e_ErrConverting = 60 , e_ErrUnknown = 100
}
 Error code. More...
 
enum class  PageLayoutMode { e_Box , e_Flow }
 Page layout mode. More...
 
enum class  ImageColorMode { e_Color , e_Gray , e_Binary }
 Image color mode. More...
 
enum class  ImageType {
  e_JPG , e_JPEG , e_PNG , e_BMP ,
  e_TIFF
}
 Image type. More...
 
enum class  ExcelWorksheetOption { e_ForTable , e_ForPage , e_ForDocument }
 Excel Worksheet option. More...
 
enum class  HtmlOption { e_SinglePage , e_SinglePageWithBookmark , e_MultiPage , e_MultiPageWithBookmark }
 Html option. More...
 

Enumeration Type Documentation

◆ ErrorCode

enum class compdfkit::base::ErrorCode
strong

Error code.

Enumerator
e_ErrSuccess 

Success, and no error occurs.

e_ErrCancel 

Conversion process was canceled.

e_ErrFile 

File cannot be found or could not be opened.

e_ErrPDFPassword 

Invalid password. Usually, this error may occur when loading a PDF document with password. When meet this, user should load document again with correct password.

e_ErrPDFPage 

PDF page failed to load.

e_ErrPDFFormat 

Format is invalid. For files, this may also mean that file is corrupted.

e_ErrPDFSecurity 

PDF document is encrypted by some unsupported security handler.

e_ErrOutOfMemory 

Out-of-memory error occurs.

e_ErrIO 

System I/O error.

e_ErrCompress 

Folder compression failed.

e_ErrLicenseInvalid 

The license is invalid.

e_ErrLicenseExpire 

The license has expired.

e_ErrLicenseUnsupportedPlatform 

The license does not support the current platform.

e_ErrLicenseUnsupportedID 

The license does not support the application id.

e_ErrLicenseUnsupportedDevice 

The license does not support the device id.

e_ErrLicensePermissionDeny 

The license does not have the function permission.

e_ErrLicenseUninitialized 

License has not been initialized.

e_ErrLicenseIllegalAccess 

Illegal access to the API interface.

e_ErrLicenseFileReadFailed 

Failed to read license file.

e_ErrLicenseOCRPermissionDeny 

The license does not have OCR permissions.

e_ErrNoTable 

No tables found in the source file.

e_ErrOCRFailure 

Failed to call OCR recognition.

e_ErrConverting 

Currently executing conversion task.

e_ErrUnknown 

Unknown error.

◆ ExcelWorksheetOption

Excel Worksheet option.

Enumerator
e_ForTable 

A worksheet to contain only one table.

e_ForPage 

A worksheet to contain table for PDF Page.

e_ForDocument 

A worksheet to contain table for PDF Document.

◆ HtmlOption

enum class compdfkit::base::HtmlOption
strong

Html option.

Enumerator
e_SinglePage 

Convert the entire PDF file into a single HTML file.

e_SinglePageWithBookmark 

Convert the PDF file into a single HTML file with an outline for navigation at the beginning of the HTML page.

e_MultiPage 

Convert the PDF file into multiple HTML files.

e_MultiPageWithBookmark 

Convert the PDF file into multiple HTML files. Each HTML file corresponds to a PDF page, and users can navigate to the next HTML file via a link at the bottom of the HTML page.

◆ ImageColorMode

Image color mode.

Enumerator
e_Color 

Color mode.

e_Gray 

Gray mode.

e_Binary 

Binary mode.

◆ ImageType

enum class compdfkit::base::ImageType
strong

Image type.

Enumerator
e_JPG 

.jpg.

e_JPEG 

.jpeg.

e_PNG 

.png.

e_BMP 

.bmp.

e_TIFF 

.tiff.

◆ OCRLanguage

enum class compdfkit::base::OCRLanguage
strong

OCR language.

Enumerator
e_UNKNOWN 

Unknown language.

e_Chinese 

Chinese (Simplified).

e_ChineseTra 

Chinese (Traditional).

e_English 

English.

e_Korean 

Korean.

e_Japanese 

Japanese.

e_Latin 

Latin.

e_Devanagari 

Devanagari.

e_Auto 

Automatically select language.

◆ PageLayoutMode

Page layout mode.

Enumerator
e_Box 

Box mode.

e_Flow 

Flowing mode.