StoreCustomDataFromFile

Właściwości dokumentu

Opis

Zapisuje niestandardowe dane z pliku w pliku PDF pod nazwą klucza. Dane można później pobrać za pomocą RetrieveCustomDataToString lub RetrieveCustomDataToFile. Można ustawić typ przechowywania (ciąg, strumień lub strumień skompresowany) i lokalizację (Document Information Dictionary albo Document Catalog). Jeśli lokalizacją jest Document Catalog, można użyć dowolnego typu przechowywania, ale klucz musi mieć specjalny prefiks przydzielony przez Adobe. Jeśli lokalizacją jest Document Information Dictionary, można użyć dowolnego klucza poza standardowymi, ale dozwolone są wyłącznie ciągi

Składnia

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);

Parametry

KeyKlucz, pod którym dane są przechowywane. Jeśli lokalizacją jest Document Information Dictionary, klucz nie może mieć wartości "Author", "Title", "Subject", "Keywords", "Creator" ani "Producer". Można użyć dowolnego innego klucza, lecz należy wybierać je starannie, aby były zrozumiałe dla użytkownika. Jeśli lokalizacją jest Document Catalog, klucz musi mieć specjalny prefiks przydzielony przez Adobe, aby uniknąć konfliktów z innym oprogramowaniem
FileNameŚcieżka i nazwa pliku zawierającego dane zapisywane w pliku PDF pod wskazanym kluczem
Location1 = przechowuj dane w Document Information Dictionary 2 = przechowuj dane w Document Catalog
Options0 = przechowuj dane jako ciąg (jedyna opcja dostępna, gdy lokalizacją jest Document Information Dictionary) 1 = przechowuj dane w strumieniu 2 = przechowuj dane w skompresowanym strumieniu

Wartości zwracane

0Nie udało się otworzyć pliku zawierającego dane albo parametr Key był nieprawidłowy
1Dane zostały zapisane pomyślnie