StoreCustomDataFromString
Свойства документа
Описание
Сохраняет пользовательские данные в PDF под именем ключа; позже их вернут RetrieveCustomDataToString, RetrieveCustomDataToVariant или RetrieveCustomDataToFile. Можно задать тип хранения (строка, поток или сжатый поток) и место (Document Information Dictionary или Document Catalog). Для Document Catalog допустим любой тип хранения, но ключ должен иметь специальный префикс, выделенный вам Adobe. Для Document Information Dictionary подойдёт любой нестандартный ключ, но хранить можно только строки
Когда Location равен 2, системные ключи каталога резервируются и возвращают 0 вместо перезаписи. В резервный набор входит OutputIntents, управляемый сценариями PDF/A и цветового вывода
Синтаксис
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 | Ключ, под которым сохраняются данные. Для Document Information Dictionary нельзя использовать ключи "Author", "Title", "Subject", "Keywords", "Creator" и "Producer"; любой другой ключ допустим, но выбирать его стоит осмысленно для пользователя. Для Document Catalog ключ должен иметь специальный префикс, выделенный вам Adobe, чтобы избежать конфликтов с другим программным обеспечением |
|---|---|
| NewValue | Новое значение данных |
| Location | 1 = хранить данные в Document Information Dictionary 2 = хранить данные в Document Catalog |
| Options | 0 = хранить данные в виде строки (единственный вариант для Document Information Dictionary) 1 = хранить данные в потоке 2 = хранить данные в сжатом потоке |
Возвращаемые значения
| 0 | Данные не сохранены: имя ключа зарезервировано |
|---|---|
| 1 | Данные сохранены успешно |