Foxit PDF SDK
foxit 命名空间参考

Foxit命名空间。 更多...

命名空间

 addon
 附加组件命名空间。
 
 common
 Common 命名空间。
 
 fdf
 FDF命名空间。
 
 fts
 全文搜索命名空间。
 
 pdf
 PDF命名空间。
 

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
 

类型定义

typedef uint32 ARGB
 ARGB 颜色类型,32 位,((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
 
typedef FX_INT64 FILESIZE
 文件大小。直接支持大文件
 
typedef CFX_ArrayTemplate< float > FloatArray
 浮点值数组。
 
typedef void * FS_HANDLE
 句柄类型。
 
typedef FX_INT16 int16
 有符号 16 位整数。
 
typedef FX_INT32 int32
 有符号 32 位整数。
 
typedef CFX_ArrayTemplate< int32Int32Array
 有符号整数值数组。
 
typedef FX_INT64 int64
 有符号 64 位整数。
 
typedef FX_INT8 int8
 有符号 8 位整数。
 
typedef CFX_Matrix Matrix
 矩阵信息,浮点型。
 
typedef CFX_Object Object
 对象类型。
 
typedef PointF Offset
 偏移信息,浮点型。
 
typedef CFX_PointF PointF
 点信息,浮点型。
 
typedef CFX_ArrayTemplate< PointFPointFArray
 PointF对象数组。
 
typedef FX_POSITION POSITION
 用于表示集合中元素位置的值。
 
typedef CFX_FloatRect RectF
 矩形,浮点型。
 
typedef CFX_ArrayTemplate< RectFRectFArray
 RectF对象数组。
 
typedef FX_RECT RectI
 矩形,整数型。
 
typedef uint32 RGB
 RGB 颜色类型,24 位,((b) | ((g) << 8) | ((r) << 16)))
 
typedef CFX_ByteString String
 字节字符串。
 
typedef FX_UINT16 uint16
 无符号 16 位整数。
 
typedef FX_UINT32 uint32
 无符号 32 位整数。
 
typedef CFX_ArrayTemplate< uint32UInt32Array
 无符号整数值数组。
 
typedef FX_UINT64 uint64
 无符号 64 位整数。
 
typedef FX_UINT8 uint8
 无符号 8 位整数。
 
typedef CFX_WideString WString
 宽字符串。
 

枚举

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
}
 错误代码的枚举。 更多...
 

详细描述

Foxit命名空间。

福昕命名空间。

Foxit namespace.

Foxit 命名空间。

Foxit PDF SDK的所有定义和类都在此命名空间内定义。

Foxit PDF SDK的所有定义和类都在此命名空间中定义。

Foxit PDF SDK 的所有定义和类都在此命名空间内定义。

Foxit PDF SDK 的所有定义和类都在此命名空间内定义。 为确保线程安全,请确保一个条形码对象仅在一个线程中执行。 当然,多个条形码对象可以在同一线程内同时执行。

福昕PDF SDK的所有定义和类都在此命名空间中定义。

所有的定义和类都在此命名空间中。

Foxit PDF SDK 的所有定义和类都在此命名空间中定义。

枚举类型说明

◆ ErrorCode

错误代码的枚举。

此枚举的值应单独使用。

枚举值
e_ErrSuccess 

成功,无错误发生。

e_ErrFile 

文件无法找到或无法打开。

e_ErrFormat 

格式无效。对于文件,这也可能意味着文件已损坏。

e_ErrPassword 

无效密码。通常,在加载带密码的 PDF 文档时可能出现此错误。 遇到此错误时,用户应使用正确的密码重新加载文档。

e_ErrHandle 

错误句柄。

e_ErrCertificate 

证书错误:PDF 文档已通过数字证书加密 但当前用户没有正确的证书。

e_ErrUnknown 

发生任何未知错误。

e_ErrInvalidLicense 

使用无效许可证初始化 Foxit PDF SDK 库。

e_ErrParam 

参数错误:函数的任何输入参数值无效。

e_ErrUnsupported 

某些类型不受支持。

e_ErrOutOfMemory 

发生内存不足错误。

e_ErrSecurityHandler 

PDF 文档被某些不受支持的安全处理程序加密。

e_ErrNotParsed 

内容尚未解析。通常,这表示 PDF 页面尚未解析。

e_ErrNotFound 

找不到预期的数据或对象。

e_ErrInvalidType 

输入对象或当前对象的类型无效。

e_ErrConflict 

新数据与现有数据冲突。

e_ErrUnknownState 

发生任何未知状态。

e_ErrDataNotReady 

数据未准备就绪。通常用作异常错误代码 当以异步方式加载文档时。

e_ErrInvalidData 

当前对象的数据无效。

e_ErrXFALoadError 

XFA 加载错误。

e_ErrNotLoaded 

当前对象尚未加载。

e_ErrInvalidState 

无效或不正确的状态。

e_ErrNotCDRM 

(仅适用于 ConnectedPDF)加载的文档不是 ConnectedPDF DRM 文档。

e_ErrCanNotConnectToServer 

(仅适用于 ConnectedPDF)无法连接到 ConnectedPDF 服务器。

e_ErrInvalidUserToken 

(仅适用于 ConnectedPDF)输入的用户令牌无效。

e_ErrNoRights 

(仅适用于 ConnectedPDF)当前用户无权打开 ConnectedPDF DRM 文档。

e_ErrRightsExpired 

(仅适用于 ConnectedPDF)当前用户的权限已过期。

e_ErrDeviceLimitation 

(仅适用于 ConnectedPDF)当前设备被限制打开 ConnectedPDF DRM 文档。

e_ErrCanNotRemoveSecurityFromServer 

(仅适用于 ConnectedPDF)无法从 ConnectedPDF 服务器移除安全性。

e_ErrCanNotGetACL 

(仅适用于 ConnectedPDF)无法从 ConnectedPDF 服务器获取 ACL。

e_ErrCanNotSetACL 

(仅适用于 ConnectedPDF)无法将 ACL 设置到 ConnectedPDF 服务器。

e_ErrIsAlreadyCPDF 

(仅适用于 ConnectedPDF)加载的文档已经是 ConnectedPDF 文档。

e_ErrIsAlreadyCDRM 

(仅适用于 ConnectedPDF)加载的文档已经是 ConnectedPDF DRM 文档。

e_ErrCanNotUploadDocInfo 

(仅适用于 ConnectedPDF)无法将 ConnectedPDF 文档信息上传到 ConnectedPDF 服务器。

e_ErrCanNotUploadCDRMInfo 

(仅适用于 ConnectedPDF)无法将 ConnectedPDF DRM 文档信息上传到 ConnectedPDF 服务器。

e_ErrInvalidWrapper 

(仅适用于 ConnectedPDF)输入的 ConnectedPDF DRM 包装文档无效。

e_ErrCanNotGetClientID 

(仅适用于 ConnectedPDF)无法从 ConnectedPDF 服务器获取客户端 ID。

e_ErrCanNotGetUserToken 

(仅适用于 ConnectedPDF)无法从 ConnectedPDF 服务器获取用户令牌。

e_ErrInvalidACL 

(仅限ConnectedPDF)输入的ACL无效。

e_ErrInvalidClientID 

(仅限ConnectedPDF)输入的客户端ID无效。

e_ErrOCREngineNotInit 

(仅限OCR)OCR引擎尚未成功初始化。

e_ErrDiskFull 

(仅限OCR)磁盘空间不足。

e_ErrOCRTrialIsEnd 

(仅限OCR)OCR模块试用期已结束。

e_ErrFilePathNotExist 

文件或文件夹路径不存在。

e_ErrComplianceEngineNotInit 

(仅限合规)合规引擎尚未成功初始化。

e_ErrComplianceEngineInvalidUnlockCode 

(仅限合规)使用无效的解锁代码初始化合规引擎。

e_ErrComplianceEngineInitFailed 

(仅限合规)初始化合规引擎失败。

e_ErrTimeStampServerMgrNotInit 

时间戳服务器管理器尚未成功初始化。

e_ErrLTVVerifyModeNotSet 

(仅限LTV)LTV验证模式尚未设置。

e_ErrLTVRevocationCallbackNotSet 

(仅限LTV)LTV的撤销回调尚未设置。

e_ErrLTVCannotSwitchVersion 

(仅限LTV)切换PDF版本失败。

e_ErrLTVCannotCheckDTS 

(仅限LTV)检查DTS失败。

e_ErrLTVCannotLoadDSS 

(仅限LTV)加载DSS失败。

e_ErrLTVCannotLoadDTS 

(仅限LTV)加载DTS失败。

e_ErrNeedSigned 

(仅限签名)正在操作的签名需要被签名。

e_ErrComplianceResourceFile 

(仅限合规)无法找到或打开合规资源文件。请检查合规资源文件夹 和该文件夹中的文件是否有效。

e_ErrTimeStampServerMgrNoDefaltServer 

时间戳服务器管理器尚未设置默认服务器。

e_ErrDefaultTimeStampServer 

无法使用当前默认时间戳服务器。请检查默认时间戳服务器是否可用。

e_ErrNoConnectedPDFModuleRight 

无"ConnectedPDF"模块权限。

e_ErrNoXFAModuleRight 

无"XFA"模块权限。

e_ErrNoRedactionModuleRight 

无"编辑"模块权限。

e_ErrNoRMSModuleRight 

无"RMS"模块权限。

e_ErrNoOCRModuleRight 

无"OCR"模块权限。

e_ErrNoComparisonModuleRight 

无"比较"模块权限。

e_ErrNoComplianceModuleRight 

无"合规"模块权限。

e_ErrNoOptimizerModuleRight 

无"优化器"模块权限。

e_ErrNoConversionModuleRight 

无"转换"模块权限。

e_ErrOfficeComNotInit 

(仅限Office转PDF)Office COM尚未成功初始化。

e_ErrNoMicroOfficeInstalled 

(仅限Office转PDF)当前系统未安装Microsoft Office。

e_ErrExcelHasNoContent 

(仅限Excel转PDF)Excel文档没有任何内容,无法转换为PDF文件。

e_ErrNoLayoutRecognitionModuleRight 

无"布局识别"模块权限。

e_ErrWPSEngineNotFound 

(仅限Office转PDF)未找到WPS office引擎。

e_ErrLibreofficeEngineNotFound 

(仅限Office转PDF)未找到LibreOffice引擎。

e_ErrNoAccessibilityModuleRight 

无"无障碍"模块权限。

e_ErrODAEngineNotFound 

(仅限DWG转PDF)未找到ODA引擎。

e_ErrNoTableMakerModuleRight 

无"表格制作器"模块权限。

e_ErrNoDWG2PDFModuleRight 

无"DWG2PDF"模块权限。

e_ErrNoAdvEditModuleRight 

无"高级编辑"模块权限。

e_ErrNoPDF2OfficeModuleRight 

无"PDF2Office"模块权限。

e_ErrURLInBlackList 

(仅限HTML转PDF)转换的URL在黑名单中。

e_ErrOFDEngineNotInit 

(仅限OFD)OFD引擎尚未成功初始化。

e_ErrNoOFDModuleRight 

无"OFD"模块权限。

e_ErrNo3DModuleRight 

无"3D"模块权限。

e_ErrInvalidRegex 

无效的正则表达式。

e_ErrNoDocumentPermission 

没有文档操作权限。

e_ErrNoOffice2PDFModuleRight 

无"Office2PDF"模块权限。

e_ErrMIPUPEEngineInitFailed 

MIP引擎:添加UPE引擎失败。

e_ErrMIPProtectionEngineInitFailed 

MIP引擎:添加保护引擎失败。

e_ErrMIPCreateProtectionHandlerFailed 

MIP引擎:创建保护处理程序失败。

e_ErrMIPGetExtendedLabelInfoByIdFailed 

MIP引擎:根据ID获取扩展标签信息失败。

e_ErrNoPrint2PDFModuleRight 

无"Print2PDF"模块权限。

e_ErrResponseDataError 

(仅限ConnectedPDF)响应数据中有错误。

e_ErrTimeout 

(仅限HTML2PDF)加载网页时发生超时。

e_ErrNoImageObject 

(用于PDF优化器)存在一些非图像类型的对象。