RetrieveCustomDataToFile

Propriétés du document

Description

Cette page documente RetrieveCustomDataToFile 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.

Syntaxe

Delphi

Function TPDFlib.RetrieveCustomDataToFile(Const Key, FileName: WideString; Location: Integer): Integer;

ActiveX

Function PDFlib::RetrieveCustomDataToFile(Key As String, FileName As String, Location As Long) As Long

DLL

int DLRetrieveCustomDataToFile(int InstanceID, const wchar_t * Key, const wchar_t * FileName, int Location);

Paramètres

Key	`Key` est un paramètre de `RetrieveCustomDataToFile`. 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.
FileName	`FileName` désigne un chemin ou un nom de fichier. Utilisez un chemin valide pour le flux actuel et conservez l'encodage attendu par l'API.
Location	`Location` est un paramètre de `RetrieveCustomDataToFile`. 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.

Valeurs de retour

0	Cette valeur décrit le résultat de `RetrieveCustomDataToFile`. 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 `RetrieveCustomDataToFile`. 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.