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 [in]
-
Handle de l’imprimante. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.
-
pFormName [in]
-
Pointeur vers une chaîne terminée par null qui spécifie le nom du formulaire. Pour obtenir les noms des formulaires pris en charge par l’imprimante, appelez la fonction EnumForms .
-
Niveau [in]
-
Version de la structure vers laquelle pForm pointe. Cette valeur doit être 1 ou 2.
-
pForm [out]
-
Pointeur vers un tableau d’octets qui reçoit la structure FORM_INFO_1 ou FORM_INFO_2 initialisée.
-
cbBuf [in]
-
Taille, en octets, du tableau pForm .
-
pcbNeeded [out]
-
Pointeur vers une valeur qui spécifie le nombre d’octets copiés si la fonction réussit ou le nombre d’octets requis si cbBuf est trop petit.
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.
Si l’appelant est distant et que level a la valeur 2, la valeur StringType du FORM_INFO_2 retourné est toujours STRING_LANGPAIR.
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 |
|
| Bibliothèque |
|
| DLL |
|
| Noms Unicode et ANSI |
GetFormW (Unicode) et GetFormA (ANSI) |