StoreCustomDataFromString

Propriétés du document

Description

Cette page documente StoreCustomDataFromString dans PDFlibPas pour le thème Propriétés du document. Les noms d'API, paramètres, classes, fichiers et valeurs littérales sont conservés afin de correspondre à la bibliothèque Delphi et aux points d'entrée DLL.

Consultez la syntaxe, les paramètres et les valeurs de retour avant d'appeler la fonction. Les blocs de code restent dans leur forme d'origine pour pouvoir être copiés sans modification.

Respectez les restrictions PDF/A, la version PDF minimale requise, les ressources externes et l'état du document sélectionné lors de l'utilisation de cette API.

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	`Key` est un paramètre de `StoreCustomDataFromString`. Utilisez le type indiqué dans la signature et une valeur cohérente avec le document PDF, la page sélectionnée ou la ressource active.
NewValue	`NewValue` est un paramètre de `StoreCustomDataFromString`. Utilisez le type indiqué dans la signature et une valeur cohérente avec le document PDF, la page sélectionnée ou la ressource active.
Location	`Location` est un paramètre de `StoreCustomDataFromString`. Utilisez le type indiqué dans la signature et une valeur cohérente avec le document PDF, la page sélectionnée ou la ressource active.
Options	`Options` est un masque de bits ou une option numérique qui ajuste le comportement de l'appel.

Valeurs de retour

0	Cette valeur décrit le résultat de `StoreCustomDataFromString`. En général, une valeur non nulle indique la réussite et 0 indique que l'opération n'a pas été effectuée.
1	Cette valeur décrit le résultat de `StoreCustomDataFromString`. En général, une valeur non nulle indique la réussite et 0 indique que l'opération n'a pas été effectuée.