AbortDoc-Funktion (wingdi.h)

Artikel
08/27/2023

Die Funktion AbortDoc beendet den aktuellen Druckauftrag und löscht alles, was seit dem letzten Aufruf der StartDoc-Funktion gezeichnet wurde.

Syntax

int AbortDoc(
  [in] HDC hdc
);

Parameter

[in] hdc

Handle mit dem Gerätekontext für den Druckauftrag.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert größer als 0 (null).

Wenn die Funktion fehlschlägt, wird der Rückgabewert SP_ERROR.

Hinweise

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, Druckerserverkonfiguration und Druckertreiberimplementierung ab– Faktoren, 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.

Anwendungen sollten die AbortDoc-Funktion aufrufen, um einen Druckauftrag zu beenden, wenn ein Fehler auftritt, oder um einen Druckauftrag zu beenden, nachdem der Benutzer diesen Auftrag abgebrochen hat. Um einen erfolgreichen Druckauftrag zu beenden, sollte eine Anwendung die EndDoc-Funktion aufrufen.

Wenn der Druck-Manager zum Starten des Druckauftrags verwendet wurde, wird durch Aufrufen von AbortDoc der gesamte Spoolauftrag gelöscht, sodass der Drucker nichts empfängt. Wenn der Druck-Manager nicht zum Starten des Druckauftrags verwendet wurde, wurden die Daten möglicherweise bereits an den Drucker gesendet. In diesem Fall setzt der Druckertreiber den Drucker zurück (wenn möglich) und beendet den Druckauftrag.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	wingdi.h (windows.h einschließen)
Bibliothek	Gdi32.lib
DLL	Gdi32.dll