ControlPrintProcessor-Funktion (winsplp.h)

  • Artikel

Mit der ControlPrintProcessor-Funktion eines Druckprozessors kann der Spooler einen Druckauftrag steuern.

Syntax

BOOL ControlPrintProcessor(
  [in] HANDLE hPrintProcessor,
  [in] DWORD  Command
);

Parameter

[in] hPrintProcessor

Vom Aufrufer bereitgestellter Druckprozessorhandle. Dies ist das Handle, das von einem vorherigen Aufruf von OpenPrintProcessor zurückgegeben wurde.

[in] Command

Vom Aufrufer bereitgestellter Befehl, der den Typ des auszuführenden Vorgangs angibt. Die folgenden Befehle sind gültig:

Get-Help Definition
JOB_CONTROL_CANCEL Die Funktion sollte den aktuellen Druckauftrag abbrechen.
JOB_CONTROL_PAUSE Die Funktion sollte den aktuellen Druckauftrag anhalten.
JOB_CONTROL_RESUME Die Funktion sollte den aktuellen Druckauftrag fortsetzen.

Rückgabewert

Wenn der Vorgang erfolgreich ist, sollte die Funktion TRUE zurückgeben. Wenn der Vorgang fehlschlägt, sollte die Funktion SetLastError aufrufen, um einen Fehlercode festzulegen, und dann FALSE zurückgeben.

Hinweise

Druckprozessoren sind erforderlich, um eine ControlPrintProcessor-Funktion zu exportieren. Der Spooler ruft die Funktion auf, wenn eine Anwendung die SetJob-Funktion aufruft, die in der Microsoft Windows SDK-Dokumentation beschrieben wird.

Basierend auf dem für Command empfangenen Wert sollte die Funktion den aktuellen Auftrag entweder anhalten, fortsetzen oder abbrechen. Die ControlPrintProcessor-Funktion kann asynchron aufgerufen werden, während die PrintDocumentOnPrintProcessor-Funktion des Druckprozessors ausgeführt wird. Daher muss eine Art Synchronisierungstechnik verwendet werden, z. B. das Festlegen eines intern definierten Ereignisobjekts, um einen Auftrag anzuhalten, und das Zurücksetzen des Ereignisobjekts, wenn der Auftrag fortgesetzt wird. Die ControlPrintProcessor-Funktion kann nach dem Festlegen oder Zurücksetzen des Ereignisobjekts schnell zurückgegeben werden, und PrintDocumentOnPrintProcessor kann warten, bis das Ereignis den richtigen Zustand aufweist.

Anforderungen

Anforderung Wert
Zielplattform Desktop
Kopfzeile winsplp.h (winsplp.h einschließen)
Bibliothek Nwprint.lib

Weitere Informationen

OpenPrintProcessor

PrintDocumentOnPrintProcessor