Partager via


AddForm, fonction

La fonction AddForm ajoute un formulaire à la liste des formulaires disponibles qui peuvent être sélectionnés pour l’imprimante spécifiée.

Syntaxe

BOOL AddForm(
  _In_ HANDLE hPrinter,
  _In_ DWORD  Level,
  _In_ LPBYTE pForm
);

Paramètres

hPrinter [in]

Handle de l’imprimante qui prend en charge l’impression avec le formulaire spécifié. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

Niveau [in]

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

pForm [in]

Pointeur vers une structure FORM_INFO_1 ou FORM_INFO_2 .

Valeur retournée

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

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

Notes

Notes

Il s’agit d’une fonction bloquante ou synchrone qui peut ne pas être retournée immédiatement. La rapidité avec laquelle cette fonction retourne dépend de facteurs d’exécution tels que l’status réseau, la configuration du serveur d’impression et les facteurs d’implémentation du pilote 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 donner l’impression que l’application ne répond pas.

Une application peut déterminer les formulaires disponibles pour une imprimante en appelant la fonction EnumForms .

Si pForm pointe vers un FORM_INFO_2, AddForm échoue si un formulaire portant le nom spécifié existe déjà ou si la valeur pKeyword de la structure existe déjà.

Spécifications

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
Spoolss.dll

Voir aussi

Impression

Fonctions API du spouleur d’impression

EnumForms

FORM_INFO_1

FORM_INFO_2

OpenPrinter