CommitSpoolData-Funktion

Die CommitSpoolData-Funktion benachrichtigt den Druckspooler, dass eine angegebene Datenmenge in eine angegebene Spooldatei geschrieben wurde und bereit ist, gerendert zu werden.

Syntax

HANDLE CommitSpoolData(
  _In_ HANDLE hPrinter,
  _In_ HANDLE hSpoolFile,
       DWORD  cbCommit
);

Parameter

hPrinter [in]

Ein Handle für den Drucker, an den der Auftrag übermittelt wurde. Dies sollte das gleiche Handle sein, das zum Abrufen von hSpoolFile mit GetSpoolFileHandle verwendet wurde.

hSpoolFile [in]

Ein Handle für die Spooldatei, die geändert wird. Beim ersten Aufruf von CommitSpoolData sollte dies dasselbe Handle sein, das von GetSpoolFileHandle zurückgegeben wurde. Nachfolgende Aufrufe von CommitSpoolData sollten das vom vorherigen Aufruf zurückgegebene Handle übergeben. Siehe Hinweise.

cbCommit

Die Anzahl der Bytes, die für den Druckspooler verpflichtet wurden.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie ein Handle an die Spooldatei zurück.

Wenn die Funktion fehlschlägt, gibt sie INVALID_HANDLE_VALUE zurück.

Bemerkungen

Anwendungen, die einen Spoolerdruckauftrag übermitteln, können GetSpoolFileHandle aufrufen und dann Daten direkt in das Spooldateihandle schreiben, indem WriteFile aufgerufen wird. Um den Druckspooler darüber zu benachrichtigen, dass die Datei Daten enthält, die gerendert werden können, muss die Anwendung CommitSpoolData aufrufen und die Anzahl der verfügbaren Bytes angeben.

Wenn CommitSpoolData mehrmals aufgerufen wird, muss jeder Aufruf das vom vorherigen Aufruf zurückgegebene Spooldateihandle verwenden. Wenn keine weiteren Daten in die Spooldatei geschrieben werden, sollte CloseSpoolFileHandle für das Dateihandle aufgerufen werden, das vom letzten Aufruf von CommitSpoolData zurückgegeben wurde.

Vor dem Aufrufen von CommitSpoolData müssen Anwendungen den Dateizeiger auf die Position festlegen, an der die Daten in die Datei geschrieben wurden. Beim Rendern der Daten in der Spoolerdatei bewegt der Druckspooler den Spooldateizeiger cbCommit bytes aus dem aktuellen Wert des Dateizeigers.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Header	Winspool.h (einschließlich Windows.h)
Bibliothek	Winspool.lib
DLL	WinSpool.drv

Siehe auch

Drucken

Druckspooler-API-Funktionen

GetSpoolFileHandle

CloseSpoolFileHandle