Fonction EngGetForm (winddi.h)
La fonction EngGetForm obtient les FORM_INFO_1 détails du formulaire spécifié.
Syntaxe
ENGAPI BOOL EngGetForm(
[in] HANDLE hPrinter,
[in] LPWSTR pFormName,
[in] DWORD Level,
[in, optional] LPBYTE pForm,
[in] DWORD cbBuf,
[out] LPDWORD pcbNeeded
);
Paramètres
[in] hPrinter
Gérez l’imprimante pour laquelle le formulaire est spécifié.
[in] pFormName
Pointeur vers une chaîne qui spécifie le nom du formulaire.
[in] Level
Spécifie la version de la structure de formulaire vers laquelle pForm pointe. Cette valeur doit être 1, ce qui indique que les informations de formulaire seront retournées dans une structure FORM_INFO_1.
[in, optional] pForm
Pointeur vers un tableau d’octets qui reçoit la structure FORM_INFO_1 initialisée.
[in] cbBuf
Spécifie la taille, en octets, de pForm.
[out] pcbNeeded
Pointeur vers une valeur qui spécifie le nombre d’octets copiés dans la mémoire tampon pointée par pForm si la fonction réussit. La valeur correspond au nombre d’octets requis pour effectuer la copie si cbBuf est trop petit.
Valeur retournée
EngGetForm retourne TRUE si la structure de formulaire est correctement copiée dans pForm. Sinon, il consigne un message d’erreur et retourne FALSE. Pour obtenir les informations d’erreur, appelez EngGetLastError.
Remarques
EngGetForm retourne une structure FORM_INFO_1 (décrite dans la documentation Microsoft Windows SDK) contenant les données de formulaire associées à pFormName. Les données écrites et leur taille sont retournées à l’appelant via pForm et pcbNeeded, respectivement. Si le tableau pointé vers pForm n’est pas assez grand pour contenir les données de formulaire, la taille de tableau requise est retournée dans pcbNeededed.
Pour obtenir la liste de tous les formulaires pris en charge, le pilote d’imprimante doit appeler EngEnumForms.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Disponible dans Windows 2000 et versions ultérieures des systèmes d’exploitation Windows. |
| Plateforme cible | Universal |
| En-tête | winddi.h (inclure Winddi.h) |
| Bibliothèque | Win32k.lib |
| DLL | Win32k.sys |