SetFormFieldDescription

Champs de formulaire

Description

Cette page documente SetFormFieldDescription dans PDFlibPas pour le thème Champs de formulaire. 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.SetFormFieldDescription(Index: Integer; Const NewDescription: WideString): Integer;

ActiveX

Function PDFlib::SetFormFieldDescription(Index As Long, NewDescription As String) As Long

DLL

int DLSetFormFieldDescription(int InstanceID, int Index, const wchar_t * NewDescription);

Paramètres

Index	`Index` est un paramètre de `SetFormFieldDescription`. 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.
NewDescription	`NewDescription` est un paramètre de `SetFormFieldDescription`. 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 `SetFormFieldDescription`. 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 `SetFormFieldDescription`. 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.