Foxit PDF SDK
FSDK::ComplianceEngine类 参考

静态 Public 成员函数

static EnableHandleTransparency (enable_handle_transparency) static SetLanguage(language)
 设置一个标志来启用或禁用透明度处理。 更多...
 
static Initialize (compliance_resource_folder_path, compliance_engine_unlockcode)
 初始化合规引擎。 更多...
 
static Release ()
 释放合规引擎。 更多...
 
static SetTempFolderPath (temp_folder_path)
 为合规引擎设置临时文件夹。 更多...
 

详细描述

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

参见
FSDK.Library

成员函数说明

◆ EnableHandleTransparency()

static FSDK::ComplianceEngine::EnableHandleTransparency ( enable_handle_transparency  )
static

设置一个标志来启用或禁用透明度处理。

参数
[in]enable_handle_transparency是否启用透明度处理。 true 表示启用透明度处理,它将在转换过程中检测并从图形对象中移除透明度。false 表示禁用。 默认值:false
返回
无。为合规引擎设置语言。

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

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

◆ Initialize()

static FSDK::ComplianceEngine::Initialize ( compliance_resource_folder_path  ,
compliance_engine_unlockcode   
)
static

初始化合规引擎。

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

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

◆ Release()

static FSDK::ComplianceEngine::Release ( )
static

释放合规引擎。

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

返回
无。

◆ SetTempFolderPath()

static FSDK::ComplianceEngine::SetTempFolderPath ( temp_folder_path  )
static

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

合规引擎可能需要存储几个文件以进行正确的处理(例如验证或转换)。 用户可以使用此函数设置临时文件夹。如果未通过此函数设置自定义临时文件夹, 将使用系统中的默认临时文件夹。

参数
[in]temp_folder_path要设置为临时文件夹的完整路径。这应该是一个有效路径, 且不应为空字符串。如果未设置,将会在应用程序同级目录下创建默认临时文件夹来时来使用。
返回
无。