StoreCustomDataFromString

Właściwości dokumentu

Opis

Zapisuje niestandardowe dane w pliku PDF pod nazwą klucza. Dane można później pobrać za pomocą funkcji RetrieveCustomDataToString, RetrieveCustomDataToVariant 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

Gdy Location ma wartość 2, klucze systemowe katalogu są zastrzeżone i zwracają 0 zamiast zostać zastąpione. Zbiór zastrzeżony obejmuje OutputIntents, zarządzany przez przepływy pracy PDF/A i wyjścia kolorów

Składnia

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

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
NewValueNowa wartość danych
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ę zapisać danych, ponieważ nazwa klucza była zastrzeżona
1Dane zostały zapisane pomyślnie