GetForm fonction)

La fonction GetForm récupère des informations sur un formulaire spécifié.

Syntaxe

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

Paramètres

hPrinter [ dans]

Handle vers l’imprimante. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

pFormName [ dans]

Pointeur vers une chaîne se terminant par un caractère null qui spécifie le nom du formulaire. Pour récupérer les noms des formulaires pris en charge par l’imprimante, appelez la fonction EnumForms .

De niveau [ dans]

Version de la structure vers laquelle pForm pointe. Cette valeur doit être 1 ou 2.

pForm [ à]

Pointeur vers un tableau d’octets qui reçoit la structure d' informations de _ formulaire _ 1 ou d' _ informations _ de formulaire 2 initialisée.

cbBuf [ dans]

Taille, en octets, du tableau pForm .

pcbNeeded [ à]

Pointeur vers une valeur qui spécifie le nombre d’octets copiés si la fonction est réussie ou le nombre d’octets requis si cbBuf est trop petit.

Valeur retournée

Si la fonction est réussie, la valeur de retour est une valeur différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro.

Remarques

Notes

Il s’agit d’une fonction de blocage ou synchrone qui peut ne pas être renvoyée immédiatement. La vitesse à laquelle cette fonction est retournée dépend des facteurs d’exécution tels que l’état du réseau, la configuration du serveur d’impression et les facteurs d’implémentation des pilotes d’imprimante qui sont difficiles à prédire lors de l’écriture d’une application. L’appel de cette fonction à partir d’un thread qui gère l’interaction avec l’interface utilisateur peut faire que l’application semble ne pas répondre.

Si l’appelant est distant et que le niveau est 2, la valeur StringType des informations de formulaire _ _ 2 retournées est toujours la chaîne _ LANGPAIR.

Configuration requise

Condition requise Valeur
Client minimal pris en charge
Windows 2000 Professionnel - [Applications de bureau uniquement]
Serveur minimal pris en charge
Windows 2000 Server - [Applications de bureau uniquement]
En-tête
Winspool. h (inclure Windows. h)
Bibliothèque
Winspool. lib
DLL
Winspool. drv
Noms Unicode et ANSI
GetFormW (Unicode) et GetFormA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

AddForm

DeleteForm

OpenPrinter

SetForm