StartDocA-Funktion (wingdi.h)

Artikel
08/27/2023

Die Funktion StartDoc startet einen Druckauftrag.

Syntax

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

Parameter

[in] hdc

Ein Handle für den Gerätekontext für den Druckauftrag.

[in] lpdi

Ein Zeiger auf eine DOCINFO-Struktur , die den Namen der Dokumentdatei und den Namen der Ausgabedatei enthält.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert größer als 0 (null). Dieser Wert ist der Druckauftragsbezeichner für das Dokument.

Wenn die Funktion fehlschlägt, ist der Rückgabewert kleiner oder gleich 0.

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 StartDoc-Funktion unmittelbar vor Beginn eines Druckauftrags aufrufen. Mit dieser Funktion wird sichergestellt, dass mehrseitige Dokumente nicht mit anderen Druckaufträgen eingestreut werden.

Anwendungen können den von StartDoc zurückgegebenen Wert verwenden, um die Priorität eines Druckauftrags abzurufen oder festzulegen. Rufen Sie die GetJob- oder SetJob-Funktion auf, und geben Sie diesen Wert als eines der erforderlichen Argumente an.

Beispiele

Ein Beispielprogramm, das diese Funktion verwendet, finden Sie unter Vorgehensweise: Drucken mithilfe der GDI-Druck-API.

Hinweis

Der wingdi.h-Header definiert StartDoc als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


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