StoreCustomDataFromFile
Documenteigenschappen
Beschrijving
Slaat custom data uit een bestand onder een sleutelnaam in de PDF op. Deze data kan later worden opgehaald met RetrieveCustomDataToString 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
Syntaxis
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 LongDLL
int DLStoreCustomDataFromFile(int InstanceID, const wchar_t * Key, const wchar_t * FileName, 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 |
|---|---|
| FileName | Het pad en de naam van het bestand met de gegevens die onder de opgegeven sleutel in de PDF moeten worden opgeslagen |
| 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 | Het bestand met de gegevens kon niet worden geopend of de parameter Key was ongeldig |
|---|---|
| 1 | De data is met succes opgeslagen |