StoreCustomDataFromString
Documenteigenschappen
Beschrijving
Slaat custom data onder een sleutelnaam in de PDF op. Deze data kan later worden opgehaald met de functies RetrieveCustomDataToString, RetrieveCustomDataToVariant of RetrieveCustomDataToFile. Het opslagtype (string, stream of gecomprimeerde stream) en de locatie (Document Information Dictionary of Document Catalog) kunnen worden ingesteld. Is de locatie de Document Catalog, dan kan elk opslagtype worden gebruikt, maar de sleutel moet een speciaal prefix hebben dat door Adobe aan u is toegewezen. Is de locatie de Document Information Dictionary, dan kan elke sleutel behalve de standaardsleutels worden gebruikt, maar alleen als strings
Wanneer Location 2 is, zijn catalogussysteemsleutels gereserveerd en retourneren ze 0 in plaats van te worden overschreven. De gereserveerde set bevat OutputIntents, die door PDF/A- en kleuruitvoerworkflows wordt beheerd
Syntaxis
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);Parameters
| Key | De sleutel waaronder de data wordt opgeslagen. Als de locatie de Document Information Dictionary is, mag de sleutel niet "Author", "Title", "Subject", "Keywords", "Creator" of "Producer" zijn. Elke andere sleutel kan worden gebruikt, maar kies sleutels zorgvuldig zodat ze voor de gebruiker logisch zijn. Als de locatie de Document Catalog is, moet de sleutel een speciaal prefix hebben dat door Adobe aan u is toegewezen om conflicten met andere software te voorkomen |
|---|---|
| NewValue | De nieuwe waarde voor de data |
| Location | 1 = De data in de Document Information Dictionary opslaan 2 = De data in de Document Catalog opslaan |
| Options | 0 = De data als string opslaan (de enige optie als de locatie de Document Information Dictionary is) 1 = De data in een stream opslaan 2 = De data in een gecomprimeerde stream opslaan |
Retourwaarden
| 0 | De data kon niet worden opgeslagen omdat de sleutelnaam een gereserveerde naam was |
|---|---|
| 1 | De data is met succes opgeslagen |