Foxit PDF SDK
foxit::addon::compliance::ComplianceEngine类 参考

继承自 Object .

Public 类型

enum  ViewOrPrintCondition {
  e_ViewOrPrintConditionAuto = 0, e_ViewOrPrintConditionCoatedGRACoL2006 = 1, e_ViewOrPrintConditionISOCoatedv2ECI = 2, e_ViewOrPrintConditionJapanColor2001Coated = 3,
  e_ViewOrPrintConditionPSOCoatedv3ECI = 4
}
 查看或打印条件的枚举。 更多...
 

静态 Public 成员函数

static void EnableHandleTransparency (bool enable_handle_transparency)
 设置标志以决定是否启用透明度处理。 更多...
 
static ErrorCode Initialize (const wchar_t *compliance_resource_folder_path, const char *compliance_engine_unlockcode)
 初始化合规性引擎。 更多...
 
static ErrorCode InitializeThreadContext ()
 为新线程初始化合规性上下文。 更多...
 
static void Release ()
 释放合规性引擎。 更多...
 
static void ReleaseThreadContext ()
 释放线程的合规性上下文。 更多...
 
static void SetLanguage (const char *language)
 为合规性引擎设置语言。 更多...
 
static void SetTempFolderPath (const wchar_t *temp_folder_path)
 为合规性引擎设置临时文件夹。 更多...
 

详细描述

合规性模块可用于验证PDF文件是否符合指定的行业标准版本(例如PDF/A版本之一) 或将PDF文件转换为指定的行业标准版本(例如PDF/A版本之一)。 在初始化合规性引擎并使用此模块中的任何类或方法之前,请确保 Foxit PDF SDK已通过函数common::Library::Initialize 使用包含"Compliance"模块的密钥成功初始化。

参见
common::Library

成员枚举类型说明

◆ ViewOrPrintCondition

查看或打印条件的枚举。

此枚举的值应该单独使用。

枚举值
e_ViewOrPrintConditionAuto 

查看或打印条件:自动。

e_ViewOrPrintConditionCoatedGRACoL2006 

查看或打印条件:Coated GRACoL 2006。

e_ViewOrPrintConditionISOCoatedv2ECI 

查看或打印条件:ISO Coated v2 (ECI)。

e_ViewOrPrintConditionJapanColor2001Coated 

查看或打印条件:Japan Color 2001 Coated。

e_ViewOrPrintConditionPSOCoatedv3ECI 

查看或打印条件:PSO Coated v3 (ECI)。

成员函数说明

◆ EnableHandleTransparency()

static void foxit::addon::compliance::ComplianceEngine::EnableHandleTransparency ( bool  enable_handle_transparency)
static

设置标志以决定是否启用透明度处理。

参数
[in]enable_handle_transparencytrue表示启用透明度处理,在转换期间检测并从图形对象中移除透明度。 false表示禁用。 默认值:false
返回
无。

◆ Initialize()

static ErrorCode foxit::addon::compliance::ComplianceEngine::Initialize ( const wchar_t *  compliance_resource_folder_path,
const char *  compliance_engine_unlockcode 
)
static

初始化合规性引擎。

在合规性附加模块中的任何其他方法之前,应成功调用此方法。

参数
[in]compliance_resource_folder_path合规性资源文件夹的完整路径。这不应该是空字符串。
[in]compliance_engine_unlockcode合规性引擎的解锁代码。
  • 如果Foxit PDF SDK使用授权密钥,请传递有效的解锁代码字符串 来初始化合规性引擎。
  • 如果Foxit PDF SDK使用试用密钥,此参数将被忽略。 只需传递空字符串。
返回
foxit::e_ErrSuccess表示成功。
foxit::e_ErrNoComplianceModuleRight表示Foxit PDF SDK未使用 包含"Compliance"模块的密钥初始化。
foxit::e_ErrParam表示参数compliance_resource_folder_path是空字符串,或 当Foxit PDF SDK使用授权密钥时参数compliance_engine_unlockcode是空字符串。
foxit::e_ErrFilePathNotExist表示参数compliance_resource_folder_path 不存在或在此文件夹下找不到合规性引擎的库。
foxit::e_ErrComplianceEngineInvalidUnlockCode表示 当Foxit PDF SDK使用授权密钥时参数compliance_engine_unlockcode是合规性引擎的无效解锁代码。
有关错误代码值的更多信息,请参考从 foxit::e_ErrSuccess开始的值。
注解
如果在函数common::Library::Initialize中使用的许可证信息中未定义 "Compliance"模块,意味着用户无权使用合规性相关功能, 此构造函数将抛出异常foxit::e_ErrNoComplianceModuleRight

◆ InitializeThreadContext()

static ErrorCode foxit::addon::compliance::ComplianceEngine::InitializeThreadContext ( )
static

为新线程初始化合规性上下文。

合规性引擎默认提供线程安全。对于多线程,在合规性附加模块中的任何其他方法之前, 应为每个线程成功调用此方法。建议使用固定数量的SDK线程 (例如最小=4,最大=系统硬件并发)。创建比CPU核心更多的线程将 降低整体性能。应尽可能长时间地重用线程。

返回
foxit::e_ErrSuccess表示成功。
foxit::e_ErrNoComplianceModuleRight表示Foxit PDF SDK未使用 包含"Compliance"模块的密钥初始化。
foxit::e_ErrComplianceEngineInvalidUnlockCode表示 当Foxit PDF SDK使用授权密钥时参数compliance_engine_unlockcode是合规性引擎的无效解锁代码。
有关错误代码值的更多信息,请参考从 foxit::e_ErrSuccess开始的值。
注解
如果在函数common::Library::Initialize中使用的许可证信息中未定义 "Compliance"模块,意味着用户无权使用合规性相关功能, 此函数将抛出异常foxit::e_ErrNoComplianceModuleRight

◆ Release()

static void foxit::addon::compliance::ComplianceEngine::Release ( )
static

释放合规性引擎。

当不再需要使用合规性引擎时,可以在Foxit PDF SDK释放之前调用此函数来释放它。

返回
无。

◆ ReleaseThreadContext()

static void foxit::addon::compliance::ComplianceEngine::ReleaseThreadContext ( )
static

释放线程的合规性上下文。

当不再需要使用时,此函数将在线程中Foxit PDF SDK释放之前释放线程的合规性上下文。 应从调用compliance::ComplianceEngine::InitializeThreadContext的同一线程调用它。

返回
无。

◆ SetLanguage()

static void foxit::addon::compliance::ComplianceEngine::SetLanguage ( const char *  language)
static

为合规性引擎设置语言。

为合规性引擎设置语言将影响通过compliance::ResultInformation 或回调类compliance::ProgressCallback返回的所有字符串。 如果此函数未设置语言名称,将使用"English"作为默认值。

参数
[in]language语言名称。这不能是空字符串,应该是以下语言名称之一: "Czech", "Danish", "Dutch", "English", "French", "Finnish", "German", "Italian", "Norwegian", "Polish", "Portuguese", "Spanish", "Swedish", "Chinese-Simplified", "Chinese-Traditional", "Japanese", "Korean"。 对于其他语言名称,此函数将不执行任何操作。
返回
无。

◆ SetTempFolderPath()

static void foxit::addon::compliance::ComplianceEngine::SetTempFolderPath ( const wchar_t *  temp_folder_path)
static

为合规性引擎设置临时文件夹。

合规性引擎在处理过程中可能生成临时文件(例如,用于验证或转换任务)。 此函数允许指定自定义存储位置。如果未设置,将会在应用程序同级目录下创建默认临时文件夹来时来使用。

参数
[in]temp_folder_path临时目录的完整路径。这应该是有效路径且 不应该是空字符串。
返回
无。