Foxit PDF SDK

静态 Public 成员函数 | 所有成员列表
FSDK::OCREngine类 参考

## 静态 Public 成员函数
static | Initialize (ocr_resource_path)
| 初始化 OCR 引擎。 更多...
static | Initialize (ocr_resource_path, is_shared_cpu_cores_mode)
| 初始化 OCR 引擎。 更多...
static | Release ()
| 释放 OCR 引擎。 更多...
static | SetLanguages (languages)
| 设置将包含在语言数据库中用于执行 OCR 的语言名称。 更多...
static | SetLogFile (log_file_path)
| 为 OCR 引擎设置日志文件。 更多...
static | SetLogFile (log_file_path)
| 为 OCR 引擎设置日志文件。 更多...
static | SetOCRCallback (callback)
| 设置用于取消 OCR 进度的回调对象。 更多...

## 详细描述

OCR 附加模块可用于将 PDF 页面或 PDF 文档中的图像文本内容转换为可搜索文本或可编辑文本。 在使用 OCR 模块之前，用户应首先准备 OCR 资源文件夹，如“Foxit PDF SDK Developer Guide.pdf”文档中所述。 在初始化 OCR 引擎并使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK 已通过函数 FSDK.Library.Initialize 成功初始化， 并且具有包含“OCR”模块的密钥。
目前，OCR 模块仅支持 Windows 和 Linux64 系统。

参见
  FSDK.Library

## 成员函数说明

## ◆ Initialize() [1/2]

static FSDK::OCREngine::Initialize | ( | ocr_resource_path |  | ) |
| static

初始化 OCR 引擎。

在 OCR 附加模块中的任何其他方法之前，应成功调用此方法。

参数

  [in] | ocr_resource_path | OCR 资源文件夹的文件路径。此参数不应为空字符串。 有关更多详细信息，请参阅“Foxit PDF SDK Developer Guide.pdf”文档。

注解
  如果在函数 FSDK.Library.Initialize 中使用的许可信息中未定义模块“OCR”， 则意味着用户没有使用 OCR 相关功能的权限， 此构造函数将抛出异常 FSDK.e_ErrNoOCRModuleRight。

返回
  FSDK.e_ErrSuccess 表示成功。
  FSDK.e_ErrNoOCRModuleRight 表示 Foxit PDF SDK 没有使用 包含“OCR”模块的密钥初始化。
  FSDK.e_ErrParam 表示参数 ocrt_resource_path 是空字符串。
  有关错误代码值的更多信息，请参阅从 FSDK.e_ErrSuccess 开始的值。

## ◆ Initialize() [2/2]

static FSDK::OCREngine::Initialize | ( | ocr_resource_path | ,
|  | is_shared_cpu_cores_mode |
| ) |  |
| static

初始化 OCR 引擎。

在 OCR 附加模块中的任何其他方法之前，应成功调用此方法。

参数

  [in] | ocr_resource_path | OCR 资源文件夹的文件路径。此参数不应为空字符串。 有关更多详细信息，请参阅“Foxit PDF SDK Developer Guide.pdf”文档。
  [in] | is_shared_cpu_cores_mode | 一个布尔值，指定是否应以共享模式使用 CPU 核心。 CPU 核心使用有两种模式：分离和共享。在分离模式下，OCR 引擎 使用的进程不超过许可证允许的数量。在共享模式下，可以运行任意数量的 进程。 true 表示应以共享模式使用 CPU 核心，而 false 表示不应。 在多进程模式下，强烈建议将此参数设置为 true， 例如调用函数 FSDK.OCR.OCRPDFDocuments。 在单进程模式下，此参数应设置为 false。 默认值：false。

注解
  如果在函数 FSDK.Library.Initialize 中使用的许可信息中未定义模块“OCR”， 则意味着用户没有使用 OCR 相关功能的权限， 此构造函数将抛出异常 FSDK.e_ErrNoOCRModuleRight。

返回
  FSDK.e_ErrSuccess 表示成功。
  FSDK.e_ErrNoOCRModuleRight 表示 Foxit PDF SDK 没有使用 包含“OCR”模块的密钥初始化。
  FSDK.e_ErrParam 表示参数 ocrt_resource_path 是空字符串。
  有关错误代码值的更多信息，请参考从 FSDK.e_ErrSuccess 开始的值。

## ◆ Release()

static FSDK::OCREngine::Release | ( |  | ) |
| static

释放 OCR 引擎。

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

返回
  无。

## ◆ SetLanguages()

static FSDK::OCREngine::SetLanguages | ( | languages |  | ) |
| static

设置将包含在语言数据库中用于执行 OCR 的语言名称。

当前支持的语言：

- 当使用 CJK 语言资源时，支持简体中文、繁体中文、日语、韩语。
- 当使用其他语言资源时，支持巴斯克语、保加利亚语、加泰罗尼亚语、克罗地亚语、捷克语、丹麦语、 荷兰语、英语、爱沙尼亚语、法罗语、芬兰语、法语、加利西亚语、德语、希腊语、希伯来语、匈牙利语、 冰岛语、意大利语、拉脱维亚语（莱特语）、立陶宛语、马其顿语、马耳他语、挪威语、波兰语、葡萄牙语、 罗马尼亚语、俄语、塞尔维亚语、斯洛伐克语、斯洛文尼亚语、西班牙语、瑞典语、泰语、土耳其语、乌克兰语、阿拉伯语。

如果此函数未设置任何语言，Foxit PDF SDK 将默认使用“英语”。

参数

  [in] | languages | 语言名称。此参数不应为空字符串。 它可以包含一个语言名称或用逗号分隔的多个语言名称。 例如，“English” 表示仅英语，“English,French” 表示仅英语和法语。

返回
  无。

## ◆ SetLogFile() [1/2]

static FSDK::OCREngine::SetLogFile | ( | log_file_path |  | ) |
| static

为 OCR 引擎设置日志文件。

此函数用于为 OCR 引擎设置日志文件，而不是为 Foxit PDF SDK 设置。 如果用户想要为 Foxit PDF SDK 设置日志文件，请参考函数 FSDK.Library.SetLogFile。

参数

  [in] | log_file_path | 日志文件路径。如果这是空字符串，则表示停止 OCR 引擎的日志。

返回
  无。

## ◆ SetLogFile() [2/2]

static FSDK::OCREngine::SetLogFile | ( | log_file_path |  | ) |
| static

为 OCR 引擎设置日志文件。

此函数用于为 OCR 引擎设置日志文件，而不是为 Foxit PDF SDK 设置。 如果用户想要为 Foxit PDF SDK 设置日志文件，请参考函数 FSDK.Library.SetLogFile。

参数

  [in] | log_file_path | 日志文件路径。如果这是空字符串，则表示停止 OCR 引擎的日志。

返回
  无。

## ◆ SetOCRCallback()

static FSDK::OCREngine::SetOCRCallback | ( | callback |  | ) |
| static

设置用于取消 OCR 进度的回调对象。

参数

  [in] | callback | 基于回调类 FSDK.OCRCallback 实现的自定义 OCR 回调。 NULL 表示不使用任何 OCR 回调对象。用户应确保所有回调函数 都已在应用程序级别实现。

返回
  无。