EngGetForm-Funktion (winddi.h)
Die EngGetForm-Funktion ruft die FORM_INFO_1 Details für das angegebene Formular ab.
Syntax
ENGAPI BOOL EngGetForm(
[in] HANDLE hPrinter,
[in] LPWSTR pFormName,
[in] DWORD Level,
[in, optional] LPBYTE pForm,
[in] DWORD cbBuf,
[out] LPDWORD pcbNeeded
);
Parameter
[in] hPrinter
Handle an den Drucker, für den das Formular angegeben wird.
[in] pFormName
Zeiger auf eine Zeichenfolge, die den Namen des Formulars angibt.
[in] Level
Gibt die Version der Formularstruktur an, auf die pForm zeigt. Dieser Wert muss 1 sein, was angibt, dass die Formularinformationen in einer FORM_INFO_1-Struktur zurückgegeben werden.
[in, optional] pForm
Zeiger auf ein Bytearray, das die initialisierte FORM_INFO_1-Struktur empfängt.
[in] cbBuf
Gibt die Größe von pForm in Bytes an.
[out] pcbNeeded
Zeiger auf einen Wert, der die Anzahl der Bytes angibt, die in den Puffer kopiert werden, auf den pForm verweist, wenn die Funktion erfolgreich ist. Der Wert ist die Anzahl der Bytes, die zum Ausführen des Kopiervorgangs erforderlich sind, wenn cbBuf zu klein ist.
Rückgabewert
EngGetForm gibt TRUE zurück, wenn die Formularstruktur erfolgreich in pForm kopiert wurde. Andernfalls wird eine Fehlermeldung protokolliert und FALSE zurückgegeben. Rufen Sie EngGetLastError auf, um die Fehlerinformationen abzurufen.
Hinweise
EngGetForm gibt eine FORM_INFO_1-Struktur zurück (die in der Microsoft Windows SDK-Dokumentation beschrieben wird), die die Formulardaten enthält, die pFormName zugeordnet sind. Die geschriebenen Daten und ihre Größe werden über pForm bzw. pcbNeeded an den Aufrufer zurückgegeben. Wenn das Array, auf das pForm verweist, nicht groß genug ist, um die Formulardaten aufzunehmen, wird stattdessen die erforderliche Arraygröße in pcbNeeded zurückgegeben.
Um eine Liste aller unterstützten Formulare zu erhalten, sollte der Druckertreiber EngEnumForms aufrufen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Verfügbar in Windows 2000 und höheren Versionen der Windows-Betriebssysteme. |
| Zielplattform | Universell |
| Header | winddi.h (einschließlich Winddi.h) |
| Bibliothek | Win32k.lib |
| DLL | Win32k.sys |