Foxit PDF SDK

Namespaces | Classes | Typedefs | Enumerations
foxit Namespace Reference

Foxit namespace. More...

## Namespaces
| addon
| Add-on namespace.
| common
| Common namespace.
| fdf
| FDF namespace.
| fts
| Full text search namespace.
| pdf
| PDF namespace.

## Classes
class | ActionCallback
class | Base
class | ButtonItem
class | DateTime
class | DialogDescriptionConfig
class | DialogDescriptionElement
class | DialogDescriptionElementArray
class | Exception
class | FloatingInfo
class | IdentityProperties
class | JavascriptModifyItemInfo
class | MediaPlayerCallback
class | MediaSettings
class | MenuItemConfig
class | MenuItemEx
class | MenuList
class | MenuListArray
class | PlayerArgs
class | PrintParams
class | SearchIndexConfig
class | SearchOption
class | SOAPAuthenticateInfo
class | SOAPRequestProperties
class | SOAPResponseInfo
class | StringArray
class | WStringArray

## Typedefs
typedef uint32 | ARGB
| ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
typedef FX_INT64 | FILESIZE
| File size. Support large file directly.
typedef CFX_ArrayTemplate< float > | FloatArray
| An array of float values.
typedef void * | FS_HANDLE
| Handle type.
typedef FX_INT16 | int16
| 16-bit signed integer.
typedef FX_INT32 | int32
| 32-bit signed integer.
typedef CFX_ArrayTemplate< int32 > | Int32Array
| An array of signed integer values.
typedef FX_INT64 | int64
| Signed 64-bit integer.
typedef FX_INT8 | int8
| 8-bit signed integer.
typedef CFX_Matrix | Matrix
| Matrix information, in float.
typedef CFX_Object | Object
| Object type.
typedef PointF | Offset
| Offset information, in float.
typedef CFX_PointF | PointF
| Point information, in float.
typedef CFX_ArrayTemplate< PointF > | PointFArray
| An array of PointF objects.
typedef FX_POSITION | POSITION
| A value used to denote the position of an element in a collection.
typedef CFX_FloatRect | RectF
| Rectangle, in float.
typedef CFX_ArrayTemplate< RectF > | RectFArray
| An array of RectF objects.
typedef FX_RECT | RectI
| Rectangle, in integer.
typedef uint32 | RGB
| RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
typedef CFX_ByteString | String
| Byte string.
typedef FX_UINT16 | uint16
| 16-bit unsigned integer.
typedef FX_UINT32 | uint32
| 32-bit unsigned integer.
typedef CFX_ArrayTemplate< uint32 > | UInt32Array
| An array of unsigned integer values.
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_ErrConflict = 15, e_ErrUnknownState = 16, e_ErrDataNotReady = 17, e_ErrInvalidData = 18, e_ErrXFALoadError = 19, e_ErrNotLoaded = 20, e_ErrInvalidState = 21, e_ErrNotCDRM = 22, e_ErrCanNotConnectToServer = 23, e_ErrInvalidUserToken = 24, e_ErrNoRights = 25, e_ErrRightsExpired = 26, e_ErrDeviceLimitation = 27, e_ErrCanNotRemoveSecurityFromServer = 28, e_ErrCanNotGetACL = 29, e_ErrCanNotSetACL = 30, e_ErrIsAlreadyCPDF = 31, e_ErrIsAlreadyCDRM = 32, e_ErrCanNotUploadDocInfo = 33, e_ErrCanNotUploadCDRMInfo = 34, e_ErrInvalidWrapper = 35, e_ErrCanNotGetClientID = 36, e_ErrCanNotGetUserToken = 37, e_ErrInvalidACL = 38, e_ErrInvalidClientID = 39, e_ErrOCREngineNotInit = 40, e_ErrDiskFull = 41, e_ErrOCRTrialIsEnd = 42, e_ErrFilePathNotExist = 43, e_ErrComplianceEngineNotInit = 44, e_ErrComplianceEngineInvalidUnlockCode = 45, e_ErrComplianceEngineInitFailed = 46, e_ErrTimeStampServerMgrNotInit = 47, e_ErrLTVVerifyModeNotSet = 48, e_ErrLTVRevocationCallbackNotSet = 49, e_ErrLTVCannotSwitchVersion = 50, e_ErrLTVCannotCheckDTS = 51, e_ErrLTVCannotLoadDSS = 52, e_ErrLTVCannotLoadDTS = 53, e_ErrNeedSigned = 54, e_ErrComplianceResourceFile = 55, e_ErrTimeStampServerMgrNoDefaltServer = 56, e_ErrDefaultTimeStampServer = 57, e_ErrNoConnectedPDFModuleRight = 58, e_ErrNoXFAModuleRight = 59, e_ErrNoRedactionModuleRight = 60, e_ErrNoRMSModuleRight = 61, e_ErrNoOCRModuleRight = 62, e_ErrNoComparisonModuleRight = 63, e_ErrNoComplianceModuleRight = 64, e_ErrNoOptimizerModuleRight = 65, e_ErrNoConversionModuleRight = 66, e_ErrOfficeComNotInit = 67, e_ErrNoMicroOfficeInstalled = 68, e_ErrExcelHasNoContent = 69, e_ErrNoLayoutRecognitionModuleRight = 70, e_ErrWPSEngineNotFound = 71, e_ErrLibreofficeEngineNotFound = 72, e_ErrNoAccessibilityModuleRight = 73, e_ErrODAEngineNotFound = 74, e_ErrNoTableMakerModuleRight = 75, e_ErrNoDWG2PDFModuleRight = 76, e_ErrNoAdvEditModuleRight = 77, e_ErrNoPDF2OfficeModuleRight = 78, e_ErrURLInBlackList = 79, e_ErrOFDEngineNotInit = 80, e_ErrNoOFDModuleRight = 81, e_ErrNo3DModuleRight = 82, e_ErrInvalidRegex = 83, e_ErrNoDocumentPermission = 84, e_ErrNoOffice2PDFModuleRight = 85, e_ErrMIPUPEEngineInitFailed = 86, e_ErrMIPProtectionEngineInitFailed = 87, e_ErrMIPCreateProtectionHandlerFailed = 88, e_ErrMIPGetExtendedLabelInfoByIdFailed = 89, e_ErrNoPrint2PDFModuleRight = 90, e_ErrResponseDataError = 91, e_ErrTimeout = 92, e_ErrNoImageObject = 93, e_ErrFXOCREngineNotInit = 94 }
| Enumeration for error code. More...

## Detailed Description

Foxit namespace.

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

All the definitions and classes of Foxit PDF SDK are defined within this namespace. To ensure thread safety, please ensure that one barcode object is executed in only one thread. Naturally, multiple barcode objects can be executed simultaneously within the same thread.

## Enumeration Type Documentation

## ◆ ErrorCode

enum foxit::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 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_ErrConflict | New data conflicts with existed data.
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_ErrInvalidData | Data of current object is invalid.
e_ErrXFALoadError | XFA loading error.
e_ErrNotLoaded | Current object has not been loaded yet.
e_ErrInvalidState | Invalid or incorrect state.
e_ErrNotCDRM | (For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
e_ErrCanNotConnectToServer | (For ConnectedPDF only) Cannot connect to ConnectedPDF server.
e_ErrInvalidUserToken | (For ConnectedPDF only) Input user token is invalid.
e_ErrNoRights | (For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
e_ErrRightsExpired | (For ConnectedPDF only) The rights of Current user has expired.
e_ErrDeviceLimitation | (For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
e_ErrCanNotRemoveSecurityFromServer | (For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
e_ErrCanNotGetACL | (For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
e_ErrCanNotSetACL | (For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
e_ErrIsAlreadyCPDF | (For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
e_ErrIsAlreadyCDRM | (For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
e_ErrCanNotUploadDocInfo | (For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
e_ErrCanNotUploadCDRMInfo | (For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
e_ErrInvalidWrapper | (For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
e_ErrCanNotGetClientID | (For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
e_ErrCanNotGetUserToken | (For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
e_ErrInvalidACL | (For ConnectedPDF only) Input ACL is invalid.
e_ErrInvalidClientID | (For ConnectedPDF only) Input client ID is invalid.
e_ErrOCREngineNotInit | (For OCR only) OCR engine has not been initialized successfully.
e_ErrDiskFull | (For OCR only) Not enough disk space.
e_ErrOCRTrialIsEnd | (For OCR only) The trial for OCR module is end.
e_ErrFilePathNotExist | File or folder path does not exist.
e_ErrComplianceEngineNotInit | (For compliance only) Compliance engine has not been initialized successfully.
e_ErrComplianceEngineInvalidUnlockCode | (For compliance only) Invalid unlock code is used to initialize compliance engine.
e_ErrComplianceEngineInitFailed | (For compliance only) Fail to initialize compliance engine.
e_ErrTimeStampServerMgrNotInit | Time stamp server manager has not been initialized successfully.
e_ErrLTVVerifyModeNotSet | (For LTV only) LTV verify mode has not been set.
e_ErrLTVRevocationCallbackNotSet | (For LTV only) Revocation callback for LTV has not been set.
e_ErrLTVCannotSwitchVersion | (For LTV only) Fail to switch PDF verion.
e_ErrLTVCannotCheckDTS | (For LTV only) Fail to check DTS.
e_ErrLTVCannotLoadDSS | (For LTV only) Fail to load DSS.
e_ErrLTVCannotLoadDTS | (For LTV only) Fail to load DTS.
e_ErrNeedSigned | (For signature only) The signature being operated needs to be signed.
e_ErrComplianceResourceFile | (For compliance only) Compliance resource file(s) cannot be found or opened. Please check if compliance resource folder and files in this folder are valid.
e_ErrTimeStampServerMgrNoDefaltServer | No default server has been set to time stamp server manager yet.
e_ErrDefaultTimeStampServer | Cannot use current default time stamp server. Please check if default time stamp server can be used.
e_ErrNoConnectedPDFModuleRight | No "ConnectedPDF" module right.
e_ErrNoXFAModuleRight | No "XFA" module right.
e_ErrNoRedactionModuleRight | No "Redaction" module right.
e_ErrNoRMSModuleRight | No "RMS" module right.
e_ErrNoOCRModuleRight | No "OCR" module right.
e_ErrNoComparisonModuleRight | No "Comparison" module right.
e_ErrNoComplianceModuleRight | No "Compliance" module right.
e_ErrNoOptimizerModuleRight | No "Optimizer" module right.
e_ErrNoConversionModuleRight | No "Conversion" module right.
e_ErrOfficeComNotInit | (For Office-to-PDF conversion only) Office COM has not been initialized successfully.
e_ErrNoMicroOfficeInstalled | (For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
e_ErrExcelHasNoContent | (For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file.
e_ErrNoLayoutRecognitionModuleRight | No "LayoutRecognition" module right.
e_ErrWPSEngineNotFound | (For Office-to-PDF conversion only) WPS office engine is not found.
e_ErrLibreofficeEngineNotFound | (For Office-to-PDF conversion only) Libre office engine is not found.
e_ErrNoAccessibilityModuleRight | No "Accessibility" module right.
e_ErrODAEngineNotFound | (For DWG-to-PDF conversion only) ODA engine is not found.
e_ErrNoTableMakerModuleRight | No "TableMaker" module right.
e_ErrNoDWG2PDFModuleRight | No "DWG2PDF" module right.
e_ErrNoAdvEditModuleRight | No "AdvEdit" module right.
e_ErrNoPDF2OfficeModuleRight | No "PDF2Office" module right.
e_ErrURLInBlackList | (For converting html to pdf only) The converted URL is on blacklist.
e_ErrOFDEngineNotInit | (For OFD only) OFD engine has not been initialized successfully.
e_ErrNoOFDModuleRight | No "OFD" module right.
e_ErrNo3DModuleRight | No "3D" module right.
e_ErrInvalidRegex | Invalid regular expression.
e_ErrNoDocumentPermission | No document permission to operate.
e_ErrNoOffice2PDFModuleRight | No "Office2PDF" module right.
e_ErrMIPUPEEngineInitFailed | MIP engine: add upe engine failed.
e_ErrMIPProtectionEngineInitFailed | MIP engine: add upe engine failed.
e_ErrMIPCreateProtectionHandlerFailed | MIP engine: create protection handler failed.
e_ErrMIPGetExtendedLabelInfoByIdFailed | MIP engine: get extended label information by id failed.
e_ErrNoPrint2PDFModuleRight | No "Print2PDF" module right.
e_ErrResponseDataError | (For ConnectedPDF only) There is some error in response data.
e_ErrTimeout | (For HTML2PDF only)Occuring timeout during loading web page.
e_ErrNoImageObject | (For PDF Optimizer PDF) There are some objects not image type.
e_ErrFXOCREngineNotInit | (For FXOCR only) FXOCR Engine has not been initialized successfully.