StoreCustomDataFromFile

Свойства документа

Описание

Сохраняет пользовательские данные из файла в PDF под именем ключа; later их вернут RetrieveCustomDataToString или RetrieveCustomDataToFile. Можно задать тип хранения (строка, поток или сжатый поток) и место (Document Information Dictionary или Document Catalog). Для Document Catalog допустим любой тип хранения, но ключ должен иметь специальный префикс, выделенный вам Adobe. Для Document Information Dictionary подойдёт любой нестандартный ключ, но хранить можно только строки

Синтаксис

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	Ключ, под которым сохраняются данные. Для Document Information Dictionary нельзя использовать ключи "Author", "Title", "Subject", "Keywords", "Creator" и "Producer"; любой другой ключ допустим, но выбирать его стоит осмысленно для пользователя. Для Document Catalog ключ должен иметь специальный префикс, выделенный вам Adobe, чтобы избежать конфликтов с другим программным обеспечением
FileName	Путь и имя файла с данными, сохраняемыми в PDF под указанным ключом
Location	1 = хранить данные в Document Information Dictionary 2 = хранить данные в Document Catalog
Options	0 = хранить данные в виде строки (единственный вариант для Document Information Dictionary) 1 = хранить данные в потоке 2 = хранить данные в сжатом потоке

Возвращаемые значения

0	Не удалось открыть файл с данными либо параметр Key имеет недопустимое значение
1	Данные сохранены успешно