StoreCustomDataFromVariant

Documenteigenschappen

Beschrijving

Deze functie slaat custom data, aangeleverd als variant-byte-array, onder een sleutelnaam in de PDF op. Deze data kan later worden opgehaald met RetrieveCustomDataToVariant. 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

ActiveX

Function PDFlib::StoreCustomDataFromVariant(Key As String, NewValue As Variant, Location As Long, Options As Long) As Long

Syntaxis

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

Key

NewValue

Een variant-byte-array met de data die in de PDF moet 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

0De parameter Location was ongeldig
1De custom data is met succes opgeslagen