Foxit PDF SDK

Public 成员函数 | 所有成员列表
com.foxit.sdk.pdf.StdEncryptData类 参考

## Public 成员函数
| StdEncryptData ()
| 构造函数。
| StdEncryptData (boolean is_encrypt_metadata, int user_permissions, int cipher, int key_length)
| 构造函数，带参数。 更多...
| StdEncryptData (StdEncryptData other)
| 构造函数，使用另一个标准加密数据对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getCipher ()
| Get 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。 更多...
boolean | getIs_encrypt_metadata ()
| Get 决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。 更多...
int | getKey_length ()
| Get 密钥长度，以字节为单位。 更多...
int | getUser_permissions ()
| Get 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。 更多...
void | set (boolean is_encrypt_metadata, int user_permissions, int cipher, int key_length)
| 设置值。 更多...
void | setCipher (int value)
| Set 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。 更多...
void | setIs_encrypt_metadata (boolean value)
| Set 决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。 更多...
void | setKey_length (int value)
| Set 密钥长度，以字节为单位。 更多...
void | setUser_permissions (int value)
| Set 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。 更多...

## 详细描述

此类表示用于类 StdSecurityHandler 的一些数据。

## 构造及析构函数说明

## ◆ StdEncryptData() [1/2]

com.foxit.sdk.pdf.StdEncryptData.StdEncryptData | ( | boolean | is_encrypt_metadata,
|  | int | user_permissions,
|  | int | cipher,
|  | int | key_length
| ) |  |

构造函数，带参数。

参数

  [in] | is_encrypt_metadata | true 表示加密元数据，false 表示不加密元数据。
  [in] | user_permissions | 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。
  [in] | cipher | 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。
  [in] | key_length | 密钥长度，以字节为单位。 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 加密算法，此值应该在5到16之间。推荐值为16。 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherAES 加密算法，此值应该是16（作为AES-128）或32（作为AES-256，仅PDF 2.0支持）。

## ◆ StdEncryptData() [2/2]

com.foxit.sdk.pdf.StdEncryptData.StdEncryptData | ( | StdEncryptData | other | ) |

构造函数，使用另一个标准加密数据对象。

参数

  [in] | other | 另一个标准加密数据对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.StdEncryptData.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getCipher()

com.foxit.sdk.pdf.StdEncryptData.getCipher | ( |  | ) |

Get 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。

返回
  加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。

## ◆ getIs_encrypt_metadata()

com.foxit.sdk.pdf.StdEncryptData.getIs_encrypt_metadata | ( |  | ) |

Get 决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。

返回
  决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。

## ◆ getKey_length()

com.foxit.sdk.pdf.StdEncryptData.getKey_length | ( |  | ) |

Get 密钥长度，以字节为单位。

- 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 加密算法，此值应该在5到16之间。推荐值为16。
- 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherAES 加密算法，此值应该是16（作为AES-128）或32（作为AES-256，仅PDF 2.0支持）。

返回
  密钥长度，以字节为单位。

## ◆ getUser_permissions()

com.foxit.sdk.pdf.StdEncryptData.getUser_permissions | ( |  | ) |

Get 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。

返回
  用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。

## ◆ set()

void com.foxit.sdk.pdf.StdEncryptData.set | ( | boolean | is_encrypt_metadata,
|  | int | user_permissions,
|  | int | cipher,
|  | int | key_length
| ) |  |

设置值。

参数

  [in] | is_encrypt_metadata | true 表示加密元数据，false 表示不加密元数据。
  [in] | user_permissions | 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。
  [in] | cipher | 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。
  [in] | key_length | 密钥长度，以字节为单位。 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 加密算法，此值应该在5到16之间。推荐值为16。 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherAES 加密算法，此值应该是16（作为AES-128）或32（作为AES-256，仅PDF 2.0支持）。

返回
  无。

## ◆ setCipher()

com.foxit.sdk.pdf.StdEncryptData.setCipher | ( | int | value | ) |

Set 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。

参数

  [in] | value | 加密算法类型。请参考从 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 开始的值，应该是这些值中的一个，除了 com.foxit.sdk.pdf.SecurityHandler.e_CipherNone 。

返回
  None.

## ◆ setIs_encrypt_metadata()

com.foxit.sdk.pdf.StdEncryptData.setIs_encrypt_metadata | ( | boolean | value | ) |

Set 决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。

参数

  [in] | value | 决定是否加密元数据的布尔值。true 表示加密元数据，false 表示不加密元数据。

返回
  None.

## ◆ setKey_length()

com.foxit.sdk.pdf.StdEncryptData.setKey_length | ( | int | value | ) |

Set 密钥长度，以字节为单位。

- 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherRC4 加密算法，此值应该在5到16之间。推荐值为16。
- 对于 com.foxit.sdk.pdf.SecurityHandler.e_CipherAES 加密算法，此值应该是16（作为AES-128）或32（作为AES-256，仅PDF 2.0支持）。

参数

  [in] | value | 密钥长度，以字节为单位。

返回
  None.

## ◆ setUser_permissions()

com.foxit.sdk.pdf.StdEncryptData.setUser_permissions | ( | int | value | ) |

Set 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。

参数

  [in] | value | 用户权限。请参考从 com.foxit.sdk.pdf.PDFDoc.e_PermPrint 开始的值，应该是这些值中的一个或多个的组合。

返回
  None.