GetForm-Funktion
Die GetForm-Funktion ruft Informationen zu einem angegebenen Formular ab.
Syntax
BOOL GetForm(
_In_ HANDLE hPrinter,
_In_ LPTSTR pFormName,
_In_ DWORD Level,
_Out_ LPBYTE pForm,
_In_ DWORD cbBuf,
_Out_ LPDWORD pcbNeeded
);
Parameter
-
hPrinter [in]
-
Ein Ziehpunkt für den Drucker. Verwenden Sie die OpenPrinter - oder AddPrinter-Funktion , um einen Druckerhandle abzurufen.
-
pFormName [in]
-
Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Namen des Formulars angibt. Rufen Sie die EnumForms-Funktion auf, um die Namen der vom Drucker unterstützten Formulare abzurufen.
-
Ebene [in]
-
Die Version der -Struktur, auf die pForm zeigt. Dieser Wert muss 1 oder 2 sein.
-
pForm [out]
-
Ein Zeiger auf ein Bytearray, das die initialisierte FORM_INFO_1 - oder FORM_INFO_2-Struktur empfängt.
-
cbBuf [in]
-
Die Größe des pForm-Arrays in Bytes.
-
pcbNeeded [ out]
-
Ein Zeiger auf einen Wert, der die Anzahl der kopierten Bytes angibt, wenn die Funktion erfolgreich ist, oder die Anzahl der erforderlichen Bytes, wenn cbBuf zu klein ist.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich null.
Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null.
Bemerkungen
Hinweis
Dies ist eine blockierende oder synchrone Funktion, die möglicherweise nicht sofort zurückgegeben wird. Wie schnell diese Funktion zurückgibt, hängt von Laufzeitfaktoren wie Netzwerk-status, Druckserverkonfiguration und Druckertreiberimplementierungsfaktoren ab, die beim Schreiben einer Anwendung schwer vorherzusagen sind. Das Aufrufen dieser Funktion aus einem Thread, der die Interaktion mit der Benutzeroberfläche verwaltet, könnte dazu führen, dass die Anwendung nicht mehr reagiert.
Wenn der Aufrufer remote ist und level 2 ist, wird der StringType-Wert des zurückgegebenen FORM_INFO_2 immer STRING_LANGPAIR.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Windows 2000 Professional [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
Windows 2000 Server [nur Desktop-Apps] |
| Header |
|
| Bibliothek |
|
| DLL |
|
| Unicode- und ANSI-Name |
GetFormW (Unicode) und GetFormA (ANSI) |