Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::ofd::OFDEnvelopeInfo类 参考
类 foxit::ofd::OFDEnvelopeInfo 继承关系图:

## Public 类型
enum | EnvelopeEncryptType { e_EnvelopeEncryptTypeRC4 = 0, e_EnvelopeEncryptTypeAES128 = 1, e_EnvelopeEncryptTypeAES192 = 2, e_EnvelopeEncryptTypeAES256 = 3, e_EnvelopeEncryptTypeSM4 = 4 }
| OFD信封加密类型定义枚举类型。 更多...

## Public 成员函数
| OFDEnvelopeInfo ()
| 构造函数。
| OFDEnvelopeInfo (const OFDEnvelopeInfo &other)
| 构造函数，通过另一个OFD信封信息对象。 更多...
| ~OFDEnvelopeInfo ()
| 析构函数。
EnvelopeEncryptType | GetCipher () const
| 获取加密类型。 更多...
foxit::DateTime | GetCreateTime () const
| 获取创建时间。 更多...
WString | GetCreator () const
| 获取创建人。 更多...
WString | GetCryptoType () const
| 获取加密类型。 更多...
WString | GetDescription () const
| 获取文件描述。 更多...
WString | GetDocType () const
| 获取文件类型。 更多...
foxit::DateTime | GetExpirationTime () const
| 获取有效期限结束时间。 更多...
WString | GetFileCode () const
| 获取文件代码。 更多...
WString | GetFilter () const
| 获取密码机密和证书加密标志位。 更多...
WString | GetHashKey () const
| 获取密码哈希值。 更多...
WString | GetPassword () const
| 获取密码。 更多...
WString | GetPermission () const
| 获取用户权限。 更多...
WString | GetSecurityType () const
| 获取安全类型。 更多...
foxit::DateTime | GetStartTime () const
| 获取有效期限开始时间。 更多...
WString | GetSubFilter () const
| 获取加密子标志位。 更多...
WString | GetTitle () const
| 获取标题。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const OFDEnvelopeInfo &other) const
| 不相等操作符。 更多...
OFDEnvelopeInfo & | operator= (const OFDEnvelopeInfo &other)
| 赋值操作符。 更多...
bool | operator== (const OFDEnvelopeInfo &other) const
| 相等操作符。 更多...
void | SetCipher (EnvelopeEncryptType cipher)
| 设置加密类型。 更多...
void | SetCreateTime (const foxit::DateTime &create_time)
| 设置创建时间。 更多...
void | SetCreator (const WString &creator)
| 设置创建人。 更多...
void | SetDescription (const WString &description)
| 设置文件描述。 更多...
void | SetDocType (const WString &doc_type)
| 设置文件类型。 更多...
void | SetExpirationTime (const foxit::DateTime &expiration_time)
| 设置有效期限结束时间。 更多...
void | SetFileCode (const WString &file_code)
| 设置文件代码。 更多...
void | SetPassword (const WString &password)
| 设置密码。 更多...
void | SetPermission (const WString &permission)
| 设置用户权限。 更多...
void | SetStartTime (const foxit::DateTime &start_time)
| 设置有效期限开始时间。 更多...
void | SetTitle (const WString &title)
| 设置文件名称。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD信封信息相关的操作。

## 成员枚举类型说明

## ◆ EnvelopeEncryptType

enum foxit::ofd::OFDEnvelopeInfo::EnvelopeEncryptType

OFD信封加密类型定义枚举类型。

该枚举值应单独使用。

枚举值
e_EnvelopeEncryptTypeRC4 | 加密类型：RC4。
e_EnvelopeEncryptTypeAES128 | 加密类型：AES128。
e_EnvelopeEncryptTypeAES192 | 加密类型：AES192。
e_EnvelopeEncryptTypeAES256 | 加密类型：AES256。
e_EnvelopeEncryptTypeSM4 | 加密类型：SM4。

## 构造及析构函数说明

## ◆ OFDEnvelopeInfo()

foxit::ofd::OFDEnvelopeInfo::OFDEnvelopeInfo | ( | const OFDEnvelopeInfo & | other | ) |

构造函数，通过另一个OFD信封信息对象。

参数

  [in] | other | 另一个OFD信封信息对象。

## 成员函数说明

## ◆ GetCipher()

EnvelopeEncryptType foxit::ofd::OFDEnvelopeInfo::GetCipher | ( |  | ) | const

获取加密类型。

返回
  加密类型。请参考从枚举 foxit::ofd::EnvelopeInfo::e_EnvelopeEncryptTypeRC4 开始的值, 这应该是这些值中的一个。

## ◆ GetCreateTime()

foxit::DateTime foxit::ofd::OFDEnvelopeInfo::GetCreateTime | ( |  | ) | const

获取创建时间。

返回
  创建时间。

## ◆ GetCreator()

WString foxit::ofd::OFDEnvelopeInfo::GetCreator | ( |  | ) | const

获取创建人。

返回
  创建人。

## ◆ GetCryptoType()

WString foxit::ofd::OFDEnvelopeInfo::GetCryptoType | ( |  | ) | const

获取加密类型。

返回
  加密类型。

## ◆ GetDescription()

WString foxit::ofd::OFDEnvelopeInfo::GetDescription | ( |  | ) | const

获取文件描述。

返回
  文件描述。

## ◆ GetDocType()

WString foxit::ofd::OFDEnvelopeInfo::GetDocType | ( |  | ) | const

获取文件类型。

返回
  文件类型。

## ◆ GetExpirationTime()

foxit::DateTime foxit::ofd::OFDEnvelopeInfo::GetExpirationTime | ( |  | ) | const

获取有效期限结束时间。

返回
  有效期限结束时间。

## ◆ GetFileCode()

WString foxit::ofd::OFDEnvelopeInfo::GetFileCode | ( |  | ) | const

获取文件代码。

返回
  文件代码。

## ◆ GetFilter()

WString foxit::ofd::OFDEnvelopeInfo::GetFilter | ( |  | ) | const

获取密码机密和证书加密标志位。

返回
  加密标志位。

## ◆ GetHashKey()

WString foxit::ofd::OFDEnvelopeInfo::GetHashKey | ( |  | ) | const

获取密码哈希值。

返回
  密码哈希值。

## ◆ GetPassword()

WString foxit::ofd::OFDEnvelopeInfo::GetPassword | ( |  | ) | const

获取密码。

返回
  密码。

## ◆ GetPermission()

WString foxit::ofd::OFDEnvelopeInfo::GetPermission | ( |  | ) | const

获取用户权限。

返回
  用户权限。

## ◆ GetSecurityType()

WString foxit::ofd::OFDEnvelopeInfo::GetSecurityType | ( |  | ) | const

获取安全类型。

返回
  安全类型。

## ◆ GetStartTime()

foxit::DateTime foxit::ofd::OFDEnvelopeInfo::GetStartTime | ( |  | ) | const

获取有效期限开始时间。

返回
  有效期限开始时间。

## ◆ GetSubFilter()

WString foxit::ofd::OFDEnvelopeInfo::GetSubFilter | ( |  | ) | const

获取加密子标志位。

返回
  加密子标志位。

## ◆ GetTitle()

WString foxit::ofd::OFDEnvelopeInfo::GetTitle | ( |  | ) | const

获取标题。

返回
  标题。

## ◆ IsEmpty()

bool foxit::ofd::OFDEnvelopeInfo::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ operator !=()

bool foxit::ofd::OFDEnvelopeInfo::operator != | ( | const OFDEnvelopeInfo & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个OFD信封信息对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

OFDEnvelopeInfo& foxit::ofd::OFDEnvelopeInfo::operator= | ( | const OFDEnvelopeInfo & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个OFD信封信息对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::ofd::OFDEnvelopeInfo::operator== | ( | const OFDEnvelopeInfo & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个OFD信封信息对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。

## ◆ SetCipher()

void foxit::ofd::OFDEnvelopeInfo::SetCipher | ( | EnvelopeEncryptType | cipher | ) |

设置加密类型。

参数

  [in] | cipher | 加密类型。请参考从枚举 foxit::ofd::EnvelopeInfo::e_EnvelopeEncryptTypeRC4 开始的值, 这应该是这些值中的一个。

返回
  无。

## ◆ SetCreateTime()

void foxit::ofd::OFDEnvelopeInfo::SetCreateTime | ( | const foxit::DateTime & | create_time | ) |

设置创建时间。

参数

  [in] | create_time | 创建时间。

返回
  无。

## ◆ SetCreator()

void foxit::ofd::OFDEnvelopeInfo::SetCreator | ( | const WString & | creator | ) |

设置创建人。

参数

  [in] | creator | 创建人。

返回
  无。

## ◆ SetDescription()

void foxit::ofd::OFDEnvelopeInfo::SetDescription | ( | const WString & | description | ) |

设置文件描述。

参数

  [in] | description | 文件描述。

返回
  无。

## ◆ SetDocType()

void foxit::ofd::OFDEnvelopeInfo::SetDocType | ( | const WString & | doc_type | ) |

设置文件类型。

参数

  [in] | doc_type | 文件类型。

返回
  无。

## ◆ SetExpirationTime()

void foxit::ofd::OFDEnvelopeInfo::SetExpirationTime | ( | const foxit::DateTime & | expiration_time | ) |

设置有效期限结束时间。

参数

  [in] | expiration_time | 有效期限结束时间。

返回
  无。

## ◆ SetFileCode()

void foxit::ofd::OFDEnvelopeInfo::SetFileCode | ( | const WString & | file_code | ) |

设置文件代码。

参数

  [in] | file_code | 文件代码。

返回
  无。

## ◆ SetPassword()

void foxit::ofd::OFDEnvelopeInfo::SetPassword | ( | const WString & | password | ) |

设置密码。

参数

  [in] | password | 密码。

返回
  无。

## ◆ SetPermission()

void foxit::ofd::OFDEnvelopeInfo::SetPermission | ( | const WString & | permission | ) |

设置用户权限。

参数

  [in] | permission | 用户权限。

返回
  无。

## ◆ SetStartTime()

void foxit::ofd::OFDEnvelopeInfo::SetStartTime | ( | const foxit::DateTime & | start_time | ) |

设置有效期限开始时间。

参数

  [in] | start_time | 有效期限开始时间。

返回
  无。

## ◆ SetTitle()

void foxit::ofd::OFDEnvelopeInfo::SetTitle | ( | const WString & | title | ) |

设置文件名称。

参数

  [in] | title | 文件名称。

返回
  无。