StoreCustomDataFromString
Propriétés du document
Description
Enregistre des données personnalisées dans le PDF sous un nom de clé. Elles pourront être récupérées avec RetrieveCustomDataToString, RetrieveCustomDataToVariant ou RetrieveCustomDataToFile. Le type de stockage (chaîne, flux ou flux compressé) et l’emplacement (dictionnaire d’informations du document ou Catalog du document) sont configurables. Dans le Catalog, tout type de stockage est permis, mais la clé doit porter un préfixe spécial attribué par Adobe. Dans le dictionnaire d’informations, toute clé non standard est permise, mais seules les chaînes sont acceptées
Lorsque Location vaut 2, les clés système du catalogue sont réservées et renvoient 0 au lieu d’être remplacées. L’ensemble réservé comprend OutputIntents, géré par les flux PDF/A et de sortie couleur
Syntaxe
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);Paramètres
| Key | Clé de stockage des données. Dans le dictionnaire d’informations, elle ne peut être "Author", "Title", "Subject", "Keywords", "Creator" ni "Producer". Toute autre clé est admise mais doit rester compréhensible. Dans le catalogue, elle doit avoir un préfixe spécial attribué par Adobe afin d’éviter les conflits |
|---|---|
| NewValue | Nouvelle valeur des données |
| Location | 1 = Stocker les données dans le dictionnaire d'informations du document 2 = Stocker les données dans le catalogue du document |
| Options | 0 = Enregistrer comme chaîne, seule option dans le dictionnaire d'informations du document 1 = Enregistrer dans un flux 2 = Enregistrer dans un flux compressé |
Valeurs de retour
| 0 | Les données n’ont pas pu être stockées car le nom de clé était réservé |
|---|---|
| 1 | Les données ont été stockées correctement |