Foxit PDF Conversion SDK
foxit Namespace Reference

Foxit namespace. More...

Namespaces

 common
 Common namespace.
 
 conversion
 Conversion namespace.
 

Classes

class  Base
 
class  Exception
 

Typedefs

typedef void * FS_HANDLE
 Handle type.
 
typedef FX_INT16 int16
 16-bit signed integer.
 
typedef FX_INT32 int32
 32-bit signed integer.
 
typedef FX_INT64 int64
 Signed 64-bit integer.
 
typedef FX_INT8 int8
 8-bit signed integer.
 
typedef CFX_Object Object
 Object type.
 
typedef CFX_ByteString String
 Byte string.
 
typedef FX_UINT16 uint16
 16-bit unsigned integer.
 
typedef FX_UINT32 uint32
 32-bit unsigned integer.
 
typedef FX_UINT64 uint64
 Unsigned 64-bit integer.
 
typedef FX_UINT8 uint8
 8-bit unsigned integer.
 
typedef CFX_WideString WString
 Wide string.
 

Enumerations

enum  ErrorCode {
  e_ErrSuccess = 0, e_ErrFile = 1, e_ErrFormat = 2, e_ErrPassword = 3,
  e_ErrHandle = 4, e_ErrCertificate = 5, e_ErrUnknown = 6, e_ErrInvalidLicense = 7,
  e_ErrParam = 8, e_ErrUnsupported = 9, e_ErrOutOfMemory = 10, e_ErrSecurityHandler = 11,
  e_ErrNotParsed = 12, e_ErrNotFound = 13, e_ErrInvalidType = 14, e_ErrUnknownState = 16,
  e_ErrDataNotReady = 17, e_ErrNotLoaded = 20, e_ErrNoPDF2OfficeModuleRight = 77, e_ErrNoOffice2PDFModuleRight = 78,
  e_ErrNoDocumentPermission = 80
}
 Enumeration for error code. More...
 

Detailed Description

Foxit namespace.

All the definitions and classes of Foxit PDF Conversion SDK are defined within this namespace.

All the definitions and classes of Foxit PDF SDK are defined within this namespace.

Enumeration Type Documentation

◆ ErrorCode

Enumeration for error code.

Values of this enumeration should be used alone.

Enumerator
e_ErrSuccess 

Success, and no error occurs.

e_ErrFile 

File cannot be found or could not be opened.

e_ErrFormat 

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

e_ErrPassword 

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_ErrHandle 

Error handle.

e_ErrCertificate 

Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate.

e_ErrUnknown 

Any unknown error occurs.

e_ErrInvalidLicense 

Invalid license is used to initialize Foxit PDF Conversion SDK library.

e_ErrParam 

Parameter error: value of any input parameter for a function is invalid.

e_ErrUnsupported 

Some types are not supported.

e_ErrOutOfMemory 

Out-of-memory error occurs.

e_ErrSecurityHandler 

PDF document is encrypted by some unsupported security handler.

e_ErrNotParsed 

Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.

e_ErrNotFound 

Expected data or object is not found.

e_ErrInvalidType 

The type of input object or current object is invalid.

e_ErrUnknownState 

Any unknown state occurs.

e_ErrDataNotReady 

Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way.

e_ErrNotLoaded 

Current object has not been loaded yet.

e_ErrNoPDF2OfficeModuleRight 

No "PDF2Office" module right.

e_ErrNoOffice2PDFModuleRight 

No "Office2PDF" module right.

e_ErrNoDocumentPermission 

No document permission to operate.