Foxit PDF Conversion SDK

Namespaces | Classes | Enumerations
foxit.common Namespace Reference

Common namespace. More...

## Classes
class | Base
class | ConvertCheckCallback
class | Library
class | Progressive
class | Range
class | WStringArray

## Enumerations
enum | ErrorCode { ErrorCode.e_ErrSuccess = 0, ErrorCode.e_ErrFile = 1, ErrorCode.e_ErrFormat = 2, ErrorCode.e_ErrPassword = 3, ErrorCode.e_ErrHandle = 4, ErrorCode.e_ErrCertificate = 5, ErrorCode.e_ErrUnknown = 6, ErrorCode.e_ErrInvalidLicense = 7, ErrorCode.e_ErrParam = 8, ErrorCode.e_ErrUnsupported = 9, ErrorCode.e_ErrOutOfMemory = 10, ErrorCode.e_ErrSecurityHandler = 11, ErrorCode.e_ErrNotParsed = 12, ErrorCode.e_ErrNotFound = 13, ErrorCode.e_ErrInvalidType = 14, ErrorCode.e_ErrUnknownState = 16, ErrorCode.e_ErrDataNotReady = 17, ErrorCode.e_ErrNotLoaded = 20, ErrorCode.e_ErrNoPDF2OfficeModuleRight = 77, ErrorCode.e_ErrNoOffice2PDFModuleRight = 78, ErrorCode.e_ErrNoDocumentPermission = 80, ErrorCode.e_ErrNotMatchFont = 82 }
| Enumeration for error code. More...
enum | UserPermissions { UserPermissions.e_PermPrint = 0x0004, UserPermissions.e_PermModify = 0x0008, UserPermissions.e_PermExtract = 0x0010, UserPermissions.e_PermAnnotForm = 0x0020, UserPermissions.e_PermFillForm = 0x0100, UserPermissions.e_PermExtractAccess = 0x0200, UserPermissions.e_PermAssemble = 0x0400, UserPermissions.e_PermPrintHigh = 0x0800 }
| Enumeration for user access permissions in a PDF document. More...

## Detailed Description

Common namespace.

## Enumeration Type Documentation

## ◆ ErrorCode

enum foxit.common.ErrorCode
| strong

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.
e_ErrNotMatchFont | Not match font .

## ◆ UserPermissions

enum foxit.common.UserPermissions
| strong

Enumeration for user access permissions in a PDF document.

Values of this enumeration can be used alone or in combination.

Enumerator
e_PermPrint | Print PDF document with normal mode. (Bit 3 in permission value) If user wants to print a higher quality level of PDF document, please set current value with value together.
e_PermModify | Modify PDF contents. (Bit 4 in permission value) If this value is set, user can modify contents of PDF document by operations other than those controlled by values , and .
e_PermExtract | Extract PDF contents. (Bit 5 in permission value) If this value is set, user can copy or otherwise extract text and graphics from the document by operations other than that controlled by value .
e_PermAnnotForm | Operate text annotations and fill in interactive form fields. (Bit 6 in permission value) If value is also set, user can create or modify interactive form fields (including signature fields).
e_PermFillForm | Fill PDF form. (Bit 9 in permission value) If this value is set, user can fill in interactive form fields (including signature fields), even if value is not used.
e_PermExtractAccess | Disabilities support. (Bit 10 in permission value) If this value is set, user can extract text and graphics in support of accessibility to users with disabilities or for other purposes.
e_PermAssemble | Assemble PDF document. (Bit 11 in permission value) If this value is set, it enables to assemble the document (Insert, rotate, or delete pages and create bookmarks or thumbnail images), regardless if value is set or not.
e_PermPrintHigh | Print PDF document with higher qualities. (Bit 12 in permission value) If this value is not set (and value is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality.