StoreCustomDataFromFile

文档属性

描述

以键名将自定义数据从文件保存到 PDF 中。随后可使用 RetrieveCustomDataToString 或 RetrieveCustomDataToFile 检索该数据。可设置存储类型（字符串、流或压缩流）和位置（文档信息字典或文档目录）。若位置为文档目录，可使用任何存储类型，但该键必须具有 Adobe 分配给你的特殊前缀。若位置为文档信息字典，可使用标准键之外的任何键，但仅可使用字符串

语法

Delphi

Function TPDFlib.StoreCustomDataFromFile(Const Key, FileName: WideString; Location, Options: Integer): Integer;

ActiveX

Function PDFlib::StoreCustomDataFromFile(Key As String, FileName As String, Location As Long, Options As Long) As Long

DLL

int DLStoreCustomDataFromFile(int InstanceID, const wchar_t * Key, const wchar_t * FileName, int Location, int Options);

参数

Key	存储数据所用的键。如果位置为文档信息字典，则键不能是 "Author"、"Title"、"Subject"、"Keywords"、"Creator" 或 "Producer"。可使用其他任何键，但应谨慎选择，使其对用户有意义。如果位置为文档目录，则键必须具有 Adobe 分配给您的特殊前缀，以避免与其他软件冲突
FileName	包含要在指定键下存储于 PDF 中的数据的文件路径和名称
Location	1 = 将数据存储在文档信息字典中 2 = 将数据存储在文档目录中
Options	0 = 将数据存储为字符串（当位置为文档信息字典时唯一可用的选项）1 = 将数据存储在流中 2 = 将数据存储在压缩流中

返回值

0	无法打开包含数据的文件，或 Key 参数无效
1	数据已成功存储