Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::CustomSecurityCallback类 参考
类 FSDK::CustomSecurityCallback 继承关系图:

## Public 成员函数
| CreateContext (filter, sub_filter, encrypt_info)
| 用于为加密和解密创建上下文的回调函数。 更多...
| DecryptData (decryptor, encrypted_data, encrypted_data_len)
| 用于解密加密数据的回调函数。 更多...
| FinishDecryptor (decryptor)
| 用于完成解密的回调函数。 更多...
| GetCipher (context)
| 用于获取密码类型的回调函数。 更多...
| GetEncryptedSize (context, obj_num, gen_num, src_data, src_data_len) EncryptData(context
| 用于获取估计的加密大小的回调函数。 更多...
| GetEncryptKey (context) GetDecryptedSize(context
| 用于获取加密密钥的回调函数。 更多...
| IsOwner (context)
| 用于检查当前用户是否是PDF文档所有者的回调函数。 更多...
| ReleaseContext (context) GetUserPermissions(context
| 用于释放加密和解密上下文的回调函数。 更多...
| StartDecryptor (context, obj_num, gen_num)
| 用于启动解密的回调函数。 更多...

## 详细描述

此类表示用于自定义解密和加密的回调对象。如果用户想要使用 自定义安全回调，用户应继承此回调类并实现纯虚函数 （作为回调函数），然后通过函数 FSDK.Library.RegisterSecurityCallback 使用任何自定义过滤器名称（遵循PDF名称 约定）将自定义安全回调对象注册到Foxit PDF SDK。 可以调用函数 FSDK.Library.UnregisterSecurityCallback 来使用已注册的过滤器名称 注销安全回调对象。

## 成员函数说明

## ◆ CreateContext()

FSDK::CustomSecurityCallback::CreateContext | ( | filter | ,
|  | sub_filter | ,
|  | encrypt_info |
| ) |  |

用于为加密和解密创建上下文的回调函数。

参数

  [in] | filter | 自定义安全回调对象的过滤器名称。
  [in] | sub_filter | 指定加密字典内容语法的子过滤器名称。
  [in] | encrypt_info | PDF文档的加密信息。

注解
  用户应实现此回调函数。

返回
  加密上下文。

## ◆ DecryptData()

FSDK::CustomSecurityCallback::DecryptData | ( | decryptor | ,
|  | encrypted_data | ,
|  | encrypted_data_len |
| ) |  |

用于解密加密数据的回调函数。

参数

  [in] | decryptor | 用户实现和创建的解密器，由回调函数 FSDK.CustomSecurityCallback.StartDecryptor返回。
  [in] | encrypted_data | 存储加密数据的缓冲区。
  [in] | encrypted_data_len | 加密数据的长度，以字节为单位。

注解
  用户应实现此回调函数。

返回
  解密的数据内容。

## ◆ FinishDecryptor()

FSDK::CustomSecurityCallback::FinishDecryptor | ( | decryptor |  | ) |

用于完成解密的回调函数。

参数

  [in] | decryptor | 用户实现和创建的解密器，由回调函数 FSDK.CustomSecurityCallback.StartDecryptor返回。

注解
  用户应实现此回调函数。

返回
  解密的数据内容。

## ◆ GetCipher()

FSDK::CustomSecurityCallback::GetCipher | ( | context |  | ) |

用于获取密码类型的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。

注解
  用户应实现此回调函数。

返回
  密码类型。请参考从FSDK.SecurityHandler.e_CipherNone开始的值， 这应该是这些值之一。

## ◆ GetEncryptedSize()

FSDK::CustomSecurityCallback::GetEncryptedSize | ( |  | context,
|  |  | obj_num,
|  |  | gen_num,
|  |  | src_data,
|  |  | src_data_len
| ) |  |

用于获取估计的加密大小的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。
  [in] | obj_num | PDF对象的对象编号。
  [in] | gen_num | PDF对象的生成编号。
  [in] | src_data | 存储要加密的明文的缓冲区。
  [in] | src_data_len | 缓冲区的长度。

注解
  用户应实现此回调函数。

返回
  估计的加密大小。

用于获取加密数据的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。
  [in] | obj_num | PDF对象的对象编号。
  [in] | gen_num | PDF对象的生成编号。
  [in] | src_data | 存储要加密的明文的缓冲区。
  [in] | src_data_len | 缓冲区的长度。

注解
  用户应实现此回调函数。

返回
  返回一个元组，第一个元素是布尔值，true 表示成功，而 false 表示失败。 第二个元素是接收加密内容的参数。第三个元素是 接收加密数据长度的参数。

## ◆ GetEncryptKey()

FSDK::CustomSecurityCallback::GetEncryptKey | ( |  | context | ) |

用于获取加密密钥的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。

注解
  用户应实现此回调函数。

返回
  加密密钥。

用于获取估计的解密数据大小的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。
  [in] | src_data_size | 要解密的源数据大小。

注解
  用户应实现此回调函数。

返回
  估计的解密数据大小。

## ◆ IsOwner()

FSDK::CustomSecurityCallback::IsOwner | ( | context |  | ) |

用于检查当前用户是否是PDF文档所有者的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。

注解
  用户应实现此回调函数。

返回
  true表示当前用户是所有者，false表示当前用户不是所有者。

## ◆ ReleaseContext()

FSDK::CustomSecurityCallback::ReleaseContext | ( |  | context | ) |

用于释放加密和解密上下文的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。

注解
  用户应实现此回调函数。

返回
  true 表示成功，而 false 表示失败。

用于获取用户权限的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。
  [in] | user_permission | 文档的原始权限设置。请参考从 FSDK.PDFDoc.e_PermPrint开始的值，这将是这些值之一或组合。

注解
  用户应实现此回调函数。

返回
  新的用户权限。请参考从FSDK.PDFDoc.e_PermPrint开始的值， 这应该是这些值之一或组合。

## ◆ StartDecryptor()

FSDK::CustomSecurityCallback::StartDecryptor | ( | context | ,
|  | obj_num | ,
|  | gen_num |
| ) |  |

用于启动解密的回调函数。

参数

  [in] | context | 加密和解密的上下文，由回调函数 FSDK.CustomSecurityCallback.CreateContext返回。
  [in] | obj_num | PDF对象的对象编号。
  [in] | gen_num | PDF对象的生成编号。

注解
  用户应实现此回调函数。

返回
  用户实现和创建的解密器。