StoreCustomDataFromString

文档属性

描述

将自定义数据以键名存入 PDF,之后可使用 RetrieveCustomDataToString、RetrieveCustomDataToVariant 或 RetrieveCustomDataToFile 函数检索,可设置存储类型(字符串、流或压缩流)和位置(文档信息字典或文档目录),若位置为文档目录,可使用任意存储类型,但键必须具有 Adobe 分配给你的特殊前缀,若位置为文档信息字典,可使用除标准键以外的任意键,但只能使用字符串

当 Location 为 2 时,会保留目录系统键,并返回 0 而非覆盖它们。保留集合包括由 PDF/A 和色彩输出工作流管理的 OutputIntents

语法

Delphi

Function TPDFlib.StoreCustomDataFromString(Const Key, NewValue: AnsiString; Location, Options: Integer): Integer;

DLL

int DLStoreCustomDataFromString(int InstanceID, const char * Key, const char * NewValue, int Location, int Options);

参数

Key存储数据所用的键。如果位置为文档信息字典,则键不能是 "Author"、"Title"、"Subject"、"Keywords"、"Creator" 或 "Producer"。可使用其他任何键,但应谨慎选择,使其对用户有意义。如果位置为文档目录,则键必须具有 Adobe 分配给您的特殊前缀,以避免与其他软件冲突
NewValue数据的新值
Location1 = 将数据存储在文档信息字典中 2 = 将数据存储在文档目录中
Options0 = 将数据存储为字符串(当位置为文档信息字典时唯一可用的选项)1 = 将数据存储在流中 2 = 将数据存储在压缩流中

返回值

0由于键名为保留名称,无法存储数据
1数据已成功存储