Foxit PDF SDK
foxit::pdf::SplitFileResult类 参考

继承自 Object .

Public 类型

enum  SplitFileState { e_SplitFileSuccess = 0, e_SplitFileErrSizeTooSmall = 1, e_SplitFileErrFileExist = 2, e_SplitFileErrAccessDeny = 3 }
 拆分文件状态的枚举。 更多...
 

Public 成员函数

 SplitFileResult ()
 构造函数。
 
 SplitFileResult (const wchar_t *before_splitting_file_name, WStringArray after_split_files_paths, SplitFileState split_file_state)
 带参数的构造函数。 更多...
 
SplitFileResultoperator= (const SplitFileResult &data)
 赋值操作符。 更多...
 

Public 属性

WStringArray after_split_files_paths
 用于表示拆分生成的多个PDF文档路径的字符串数组。 更多...
 
WString before_splitting_file_name
 用于表示拆分前原始PDF文件名的字符串值。 更多...
 
SplitFileState split_file_state
 用于表示拆分生成的PDF文档状态的枚举值。 更多...
 

详细描述

此类表示拆分生成的PDF文档的结果信息。

成员枚举类型说明

◆ SplitFileState

拆分文件状态的枚举。

此枚举的值应该单独使用。

枚举值
e_SplitFileSuccess 

状态为拆分成功。

e_SplitFileErrSizeTooSmall 

状态为因文件大小过小而失败。

@detail 如果要拆分的PDF文档的文件大小小于StartSplitByFileSize函数中参数 max_file_size 的值, 则此状态将在文件拆分结果中返回。

e_SplitFileErrFileExist 

状态为因文件存在而失败。

@detail 如果拆分产生的PDF文档已经存在,且SplitOutputSettingData对象中的 is_overwrite 值 设置为false,则此状态将在文件拆分结果中返回。

e_SplitFileErrAccessDeny 

状态为因文件访问被拒绝而失败。

@detail 如果要拆分的PDF文档被拒绝访问,则此状态将在文件拆分结果中返回。状态为因文件访问被拒绝而失败。

构造及析构函数说明

◆ SplitFileResult()

foxit::pdf::SplitFileResult::SplitFileResult ( const wchar_t *  before_splitting_file_name,
WStringArray  after_split_files_paths,
SplitFileState  split_file_state 
)
inline

带参数的构造函数。

参数
[in]before_splitting_file_name用于表示拆分前原始PDF文件名的字符串值。
[in]after_split_files_paths用于表示拆分生成的多个PDF文档路径的字符串数组。
[in]split_file_state用于表示拆分生成的PDF文档状态的枚举值。

成员函数说明

◆ operator=()

SplitFileResult& foxit::pdf::SplitFileResult::operator= ( const SplitFileResult data)
inline

赋值操作符。

参数
[in]data另一个拆分文件结果数据对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

类成员变量说明

◆ after_split_files_paths

WStringArray foxit::pdf::SplitFileResult::after_split_files_paths

用于表示拆分生成的多个PDF文档路径的字符串数组。

◆ before_splitting_file_name

WString foxit::pdf::SplitFileResult::before_splitting_file_name

用于表示拆分前原始PDF文件名的字符串值。

◆ split_file_state

SplitFileState foxit::pdf::SplitFileResult::split_file_state

用于表示拆分生成的PDF文档状态的枚举值。