Foxit PDF SDK

类方法 | 所有成员列表
FSLibrary类 参考

继承自 NSObject .

## 类方法
(void) | + destroy
| 释放Foxit PDF SDK库分配的所有资源。 更多...
(void) | + enableThreadSafety:
| 启用线程安全。 更多...
(FSErrorCode) | + flushLog
| 刷新日志文件。 更多...
(FSErrorCode) | + initialize:key:
| 使用有效的许可证信息初始化Foxit PDF SDK库。 更多...
(FSErrorCode) | + initializeWithJSXFAThreadsafety:key:is_optimize_memory:enable_js_xfa_threadsafety:
| 使用有效的许可证信息初始化Foxit PDF SDK库。 更多...
(BOOL) | + setAnnotIconProviderCallback:
| 设置自定义的 FSIconProviderCallback 对象到Foxit PDF SDK。 更多...
(void) | + setDefaultICCProfilesPath:
| 设置包含默认ICC配置文件的文件夹路径。 更多...

## 详细描述

此类表示库管理。 它包含初始化/重新初始化/释放Foxit PDF SDK库的函数，还包含 全局使用的函数。
任何应用程序都应该在调用任何其他Foxit PDF SDK函数之前，通过函数 FSLibrary::initialize:key: 加载Foxit PDF SDK。 当不再需要使用Foxit PDF SDK时，请调用 函数 FSLibrary::destroy。
当发生某些错误时，Foxit PDF SDK中的函数可能会抛出异常。用户可以捕获这些异常并 检查从 FSErrFile 开始的错误代码值，以了解更多关于发生了什么错误的信息。

注解
  在应用程序的生命周期中，FSLibrary::initialize:key: 和 FSLibrary::destroy 应该 成对调用，且只能调用一次。一旦在应用程序的生命周期中调用了 FSLibrary::destroy， 在该应用程序的生命周期中就无法再初始化Foxit PDF SDK。 在调用 FSLibrary::destroy 之前，如果用户想重新初始化Foxit PDF SDK，请参考 函数 FSLibrary::reinitialize。

## 函数文档

## ◆ destroy()

+ (void) destroy |  |  |

释放Foxit PDF SDK库分配的所有资源。

用户应该调用此函数来释放库分配的所有内存块。
一旦调用此函数，Foxit PDF SDK库就无法在应用程序的生命周期中 再次初始化。

返回
  无。

## ◆ enableThreadSafety:()

+ (void) enableThreadSafety: |  | (BOOL) | is_enable_thread_safety |

启用线程安全。

从Foxit PDF SDK 11.0开始，默认情况下启用文档级别的线程安全（除Javascript和xfa模块外） 而无需调用此函数。此函数将在未来版本中被弃用。 用户需要确保一个pdf文档同时只被一个线程操作。 如果用户要为javascript和xfa模块启用线程安全，请在调用函数 FSLibrary::initialize:key: 时向 enable_js_xfa_threadsafety 传递 YES。

目前，模块"OCR"不支持线程安全。

参数

  [in] | is_enable_thread_safety | 启用线程安全。YES 表示启用线程安全， NO 表示禁用线程安全。

返回
  无。

## ◆ flushLog()

+ (FSErrorCode) flushLog |  |  |

刷新日志文件。

返回
  错误代码。

## ◆ initialize:key:()

+ (FSErrorCode) initialize: |  | (NSString *) | sn
key: |  | (NSString *) | key

使用有效的许可证信息初始化Foxit PDF SDK库。

在应用程序的生命周期中，此函数只能调用一次，并且 应该在调用Foxit PDF SDK中的任何其他函数之前首先调用。
一旦调用了函数 FSLibrary::destroy，Foxit PDF SDK库就无法 在该应用程序的生命周期中再次初始化。

参数

  [in] | sn | SN信息字符串，可以从密钥文件"gsdk_sn.txt"或"rdk_sn.txt"中的"SN="部分获取。
  [in] | key | 密钥信息字符串，可以从密钥文件"gsdk_key.txt"或"rdk_key.txt"中的"Sign="部分获取。

返回
  FSErrSuccess 表示成功。
  FSErrInvalidLicense 表示输入的许可证信息无效。
  FSErrParam 表示参数 sn 或 key 是空字符串。
  有关错误代码值的更多信息，请参考从 FSErrSuccess 开始的值。

## ◆ initializeWithJSXFAThreadsafety:key:is_optimize_memory:enable_js_xfa_threadsafety:()

+ (FSErrorCode) initializeWithJSXFAThreadsafety: |  | (NSString *) | sn
key: |  | (NSString *) | key
is_optimize_memory: |  | (BOOL) | is_optimize_memory
enable_js_xfa_threadsafety: |  | (BOOL) | enable_js_xfa_threadsafety

使用有效的许可证信息初始化Foxit PDF SDK库。

在应用程序的生命周期中，此函数只能调用一次，并且 应该在调用Foxit PDF SDK中的任何其他函数之前首先调用。
一旦调用了函数 FSLibrary::destroy，Foxit PDF SDK库就无法 在该应用程序的生命周期中再次初始化。

    @param[in] sn
        SN信息字符串，可以从密钥文件"gsdk_sn.txt"或"rdk_sn.txt"中的"SN="部分获取。

    @param[in] key
        密钥信息字符串，可以从密钥文件"gsdk_key.txt"或"rdk_key.

This property has effect on line annotation's appearance. Fill color is used for some line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".

## ◆ setAnnotIconProviderCallback:()

+ (BOOL) setAnnotIconProviderCallback: |  | (id<FSIconProviderCallback>) | annot_icon_provider |

设置自定义的 FSIconProviderCallback 对象到Foxit PDF SDK。

用户可以调用此函数为注释设置自定义图标提供程序。 如果此函数被多次调用，Foxit PDF SDK将只保留最后一个图标提供程序。 如果此函数从未被调用过，Foxit PDF SDK将使用默认的标准图标提供程序。

参数

  [in] | annot_icon_provider | 自定义的注释图标提供程序， 基于回调类 FSIconProviderCallback 实现。 如果这是 nil，自定义注释图标提供程序 将从Foxit PDF SDK中移除，并使用默认的标准图标提供程序。 应用程序应确保此图标提供程序对象在被从Foxit PDF SDK中移除或 调用函数 FSLibrary::destroy 之前保持有效。

返回
  YES 表示成功，NO 表示失败。

注解
  图标提供程序的ID和版本被视为图标提供程序的名称， 因此请通过回调函数 FSIconProviderCallback::getProviderID 和 FSIconProviderCallback::getProviderVersion 为不同的图标提供程序提供不同的"ID + 版本"。

## ◆ setDefaultICCProfilesPath:()

+ (void) setDefaultICCProfilesPath: |  | (NSString *) | icc_profile_folder_path |

设置包含默认ICC配置文件的文件夹路径。

默认ICC配置文件在Foxit PDF SDK包的"res"文件夹中提供。默认ICC配置文件 "sRGB Color Space Profile.icm"、"sGray.icc"和"USWebCoatedSWOP.icc"。Foxit PDF SDK将 从输入的文件夹路径中加载这些默认的ICC配置文件。
如果输入的文件夹路径不存在或指定文件夹中没有包含所有默认的ICC配置文件， 此函数将抛出异常 FSErrFilePathNotExist。

参数

  [in] | icc_profile_folder_path | 包含默认ICC配置文件的有效文件夹路径。

返回
  无。