StartDocW-Funktion (wingdi.h)

Artikel
11/20/2024

Die StartDoc--Funktion startet einen Druckauftrag.

Syntax

int StartDocW(
  [in] HDC            hdc,
  [in] const DOCINFOW *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. Dieser Wert ist der Druckauftragsbezeichner für das Dokument.

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

Bemerkungen

Hinweis Dies ist eine blockierende oder synchrone Funktion und wird möglicherweise nicht sofort zurückgegeben. Wie schnell diese Funktion zurückgegeben wird, hängt von Laufzeitfaktoren wie Netzwerkstatus, Druckserverkonfiguration und Druckertreiberimplementierung ab – Faktoren, die beim Schreiben einer Anwendung schwer vorhergesagt werden können. Das Aufrufen dieser Funktion über einen Thread, der die Interaktion mit der Benutzeroberfläche verwaltet, kann dazu führen, dass die Anwendung scheinbar nicht reagiert.

Anwendungen sollten die StartDoc--Funktion unmittelbar vor beginn eines Druckauftrags aufrufen. Durch die Verwendung dieser Funktion wird sichergestellt, dass mehrseitige Dokumente nicht mit anderen Druckaufträgen überlappen.

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 How To: Print Using the GDI Print API.

Anmerkung

Der wingdi.h-Header definiert StartDoc als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	wingdi.h (enthalten Windows.h)
Library	Gdi32.lib
DLL-	Gdi32.dll