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 an den Drucker, an den der Auftrag übermittelt wurde. Dies sollte der gleiche Handle sein, der zum Abrufen von hSpoolFile mit GetSpoolFileHandle verwendet wurde.

hSpoolFile [in]

Ein Handle zur geänderten Spooldatei. Bei dem ersten Aufruf von CommitSpoolData sollte dies derselbe Handle sein, der von GetSpoolFileHandle zurückgegeben wurde. Nachfolgende Aufrufe von CommitSpoolData sollten den von dem vorherigen Aufruf zurückgegebenen Handle übergeben. Siehe Hinweise.

cbCommit

Die Anzahl der Bytes, die an den Druckspooler gebunden sind.

Rückgabewert

Wenn die Funktion erfolgreich verläuft, wird ein Handle an die Spooldatei zurückgegeben.

Wenn die Funktion fehlschlägt, wird INVALID_HANDLE_VALUE zurückgegeben.

Bemerkungen

Anwendungen, die einen Spooler-Druckauftrag übermitteln, können GetSpoolFileHandle aufrufen und dann direkt Daten in das Spooldateihandle schreiben, indem Sie WriteFile aufrufen. Um den Druckpooler 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 bereitstellen.

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 den vom letzten Aufruf von CommitSpoolData zurückgegebenen Dateihandle aufgerufen werden.

Vor dem Aufrufen von CommitSpoolData müssen Anwendungen den Dateizeiger auf die Position festlegen, die sie hatte, bevor sie Daten in die Datei geschrieben hat. Beim Rendern der Daten in der Spooler-Datei verschärbt der Druckspooler den Spooldateizeiger cbCommit Bytes aus dem aktuellen Wert des Dateizeigers.

Requirements (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ßen Windows.h)
Bibliothek
Winspool.lib
DLL
WinSpool.drv

Weitere Informationen

Drucken

Druckspooler-API-Funktionen

GetSpoolFileHandle

CloseSpoolFileHandle