Druckspooler-API-Funktionen

  • Artikel

Die Druckspooler-API enthält die Funktionen und Datenstrukturen, die Anwendungen zum Verwalten des Windows-Druckspoolers und der von ihr gesteuerten Drucker und Druckaufträge verwenden.

Die Funktionen der Druckspooler-API sind in die folgenden Gruppen unterteilt:

Diese Funktionen senden Druckaufträge an einen Drucker und verfolgen und steuern die Druckaufträge im Druckspooler.

Funktion BESCHREIBUNG
Addjob
 Die AddJob-Funktion fügt der Liste der Druckaufträge, die vom Druckspooler geplant werden können, einen Druckauftrag hinzu. Die Funktion ruft den Namen der Datei ab, die Sie zum Speichern des Auftrags verwenden können.
ClosePrinter
 Die ClosePrinter-Funktion schließt das angegebene Druckerobjekt.
DocumentEvent
 Die DocumentEvent-Funktion ist ein Ereignishandler für Ereignisse, die dem Drucken eines Dokuments zugeordnet sind.
Documentproperties
 Die DocumentProperties-Funktion ruft Druckerinitialisierungsinformationen ab oder ändert sie oder zeigt ein Eigenschaftenblatt für die Druckerkonfiguration für den angegebenen Drucker an.
EndDocPrinter
 Die EndDocPrinter-Funktion beendet einen Druckauftrag für den angegebenen Drucker.
EndPagePrinter
 Die EndPagePrinter-Funktion benachrichtigt den Druckspooler, dass sich die Anwendung am Ende einer Seite in einem Druckauftrag befindet.
EnumJobs
 Die EnumJobs-Funktion ruft Informationen zu einem angegebenen Satz von Druckaufträgen für einen angegebenen Drucker ab.
GetJob
 Die GetJob-Funktion ruft Informationen zu einem angegebenen Druckauftrag ab.
OpenPrinter
 Die OpenPrinter-Funktion ruft ein Handle an den angegebenen Drucker oder Druckserver oder andere Arten von Handles im Drucksubsystem ab.
OpenPrinter2
 Ruft ein Handle für den angegebenen Drucker, Druckserver oder andere Arten von Handles im Drucksubsystem ab, während einige der Druckeroptionen festgelegt werden.
ReportJobProcessingProgress
 Meldet dem Druckspooler-Dienst, ob sich ein XPS-Druckauftrag in der Spooling- oder Renderingphase befindet und welcher Teil der Verarbeitung gerade ausgeführt wird.
ScheduleJob
 Die ScheduleJob-Funktion fordert an, dass der Druckspooler einen angegebenen Druckauftrag für den Druck plant.
SetJob
 Mit der SetJob-Funktion wird ein Druckauftrag auf einem angegebenen Drucker angehalten, fortgesetzt, abgebrochen oder neu gestartet. Sie können auch die SetJob-Funktion verwenden, um Druckauftragsparameter festzulegen, z. B. die Druckauftragspriorität und den Dokumentnamen.
StartDocPrinter
 Die Funktion StartDocPrinter benachrichtigt den Druckspooler, dass ein Dokument zum Drucken in die Warteschlange eingespoolt werden soll.
StartPagePrinter
 Die StartPagePrinter-Funktion benachrichtigt den Spooler, dass eine Seite auf dem angegebenen Drucker gedruckt werden soll.

Funktionen der Drucker-Benutzeroberfläche

Diese Funktionen zeigen eine Benutzeroberfläche an, die es dem Benutzer ermöglicht, einen Drucker auszuwählen oder zu konfigurieren.

Funktion BESCHREIBUNG
AdvancedDocumentProperties
 Die AdvancedDocumentProperties-Funktion zeigt ein Druckerkonfigurationsdialogfeld für den angegebenen Drucker an, sodass der Benutzer diesen Drucker konfigurieren kann.
ConfigurePort
 Die ConfigurePort-Funktion zeigt das Dialogfeld port-configuration für einen Port auf dem angegebenen Server an.
ConnectToPrinterDlg
 Die Funktion ConnectToPrinterDlg zeigt ein Dialogfeld an, in dem Benutzer Drucker in einem Netzwerk durchsuchen und eine Verbindung mit diesen herstellen können. Wenn der Benutzer einen Drucker auswählt, versucht die Funktion, eine Verbindung mit dem Drucker herzustellen. Wenn auf dem Server kein geeigneter Treiber installiert ist, hat der Benutzer die Möglichkeit, einen Drucker lokal zu erstellen.
PrinterProperties
 Die PrinterProperties-Funktion zeigt ein Eigenschaftenblatt für druckereigenschaften für den angegebenen Drucker an.

Druckerfunktionen

Mit diesen Funktionen werden die Drucker hinzugefügt und konfiguriert, die vom Druckspooler verwendet werden.

Funktion BESCHREIBUNG
AbortPrinter
 Die AbortPrinter-Funktion löscht die Spooldatei eines Druckers, wenn der Drucker für Spooling konfiguriert ist.
AddPrinter
 Die AddPrinter-Funktion fügt der Liste der unterstützten Drucker für einen angegebenen Server einen Drucker hinzu.
AddPrinterConnection
 Die AddPrinterConnection-Funktion fügt dem aktuellen Benutzer eine Verbindung mit dem angegebenen Drucker hinzu.
AddPrinterConnection2
 Fügt dem angegebenen Drucker für den aktuellen Benutzer eine Verbindung hinzu und gibt Verbindungsdetails an.
DeletePrinter
 Die DeletePrinter-Funktion löscht das angegebene Druckerobjekt.
DeletePrinterConnection
 Die DeletePrinterConnection-Funktion löscht eine Verbindung mit einem Drucker, der durch einen Aufruf von AddPrinterConnection oder ConnectToPrinterDlg hergestellt wurde.
DeletePrinterData
 Die DeletePrinterData-Funktion löscht die angegebenen Konfigurationsdaten für einen Drucker. Die Konfigurationsdaten eines Druckers bestehen aus einem Satz benannter und typisierter Werte. Die DeletePrinterData-Funktion löscht einen dieser Werte, angegeben durch den Wertnamen.
DeletePrinterDataEx
 Die DeletePrinterDataEx-Funktion löscht einen angegebenen Wert aus den Konfigurationsdaten für einen Drucker. Die Konfigurationsdaten eines Druckers bestehen aus einem Satz benannter und typisierter Werte, die in einer Hierarchie von Registrierungsschlüsseln gespeichert sind. Die Funktion löscht einen angegebenen Wert unter einem angegebenen Schlüssel.
DeletePrinterKey
 Die DeletePrinterKey-Funktion löscht einen angegebenen Schlüssel und alle zugehörigen Unterschlüssel für einen angegebenen Drucker.
EnumPrinterData
 Die EnumPrinterData-Funktion listet Konfigurationsdaten für einen angegebenen Drucker auf.
EnumPrinterDataEx
 Die EnumPrinterDataEx-Funktion listet alle Wertnamen und Daten für einen angegebenen Drucker und Schlüssel auf.
EnumPrinterKey
 Die EnumPrinterKey-Funktion listet die Unterschlüssel eines angegebenen Schlüssels für einen angegebenen Drucker auf.
EnumPrinters
 Die EnumPrinters-Funktion listet verfügbare Drucker, Druckserver, Domänen oder Druckanbieter auf.
FlushPrinter
 Die FlushPrinter-Funktion sendet einen Puffer an den Drucker, um ihn aus einem vorübergehenden Zustand zu löschen.
GetDefaultPrinter
 Die GetDefaultPrinter-Funktion ruft den Druckernamen des Standarddruckers für den aktuellen Benutzer auf dem lokalen Computer ab.
GetPrinter
 Die GetPrinter-Funktion ruft Informationen zu einem angegebenen Drucker ab.
GetPrinterData
 Die GetPrinterData-Funktion ruft Konfigurationsdaten für den angegebenen Drucker oder Druckserver ab.
GetPrinterDataEx
 Die GetPrinterDataEx-Funktion ruft Konfigurationsdaten für den angegebenen Drucker oder Druckserver ab. GetPrinterDataEx kann werte abrufen, die von der SetPrinterData-Funktion gespeichert sind. Darüber hinaus kann GetPrinterDataEx Werte abrufen, die unter einem angegebenen Schlüssel von der SetPrinterDataEx-Funktion gespeichert sind.
IsValidDevmode
 Die IsValidDevmode-Funktion überprüft, ob der Inhalt einer DEVMODE-Struktur gültig ist.
ReadPrinter
 Die ReadPrinter-Funktion ruft Daten vom angegebenen Drucker ab.
ResetPrinter
 Die ResetPrinter-Funktion gibt die Werte des Datentyps und des Gerätemodus an, die zum Drucken von Dokumenten verwendet werden sollen, die von der StartDocPrinter-Funktion übermittelt werden. Diese Werte können mit der SetJob-Funktion überschrieben werden, nachdem der Dokumentdruck gestartet wurde.
SetDefaultPrinter
 Die SetDefaultPrinter-Funktion legt den Druckernamen des Standarddruckers für den aktuellen Benutzer auf dem lokalen Computer fest.
SetPort
 Die SetPort-Funktion legt die status fest, die einem Druckerport zugeordnet ist.
SetPrinter
 Die SetPrinter-Funktion legt die Daten für einen angegebenen Drucker fest oder legt den Zustand des angegebenen Druckers fest, indem der Druck angehalten, der Druck fortgesetzt oder alle Druckaufträge entfernt werden.
SetPrinterData
 Die SetPrinterData-Funktion legt die Konfigurationsdaten für einen Drucker oder Druckserver fest.
SetPrinterDataEx
 Die SetPrinterDataEx-Funktion legt die Konfigurationsdaten für einen Drucker oder Druckserver fest. Die Funktion speichert die Konfigurationsdaten unter dem Registrierungsschlüssel des Druckers.
WritePrinter
 Die WritePrinter-Funktion benachrichtigt den Druckspooler darüber, dass Daten auf den angegebenen Drucker geschrieben werden sollen.

Druckeränderungsbenachrichtigungsfunktionen

Mit diesen Funktionen kann eine Anwendung über Änderungen am status eines Druckers benachrichtigt werden.

Funktion BESCHREIBUNG
FindClosePrinterChangeNotification
 Die FindClosePrinterChangeNotification-Funktion schließt ein Änderungsbenachrichtigungsobjekt, das durch Aufrufen der FindFirstPrinterChangeNotification-Funktion erstellt wird. Der Drucker oder Druckserver, der dem Änderungsbenachrichtigungsobjekt zugeordnet ist, wird von diesem Objekt nicht mehr überwacht.
FindFirstPrinterChangeNotification
 Die FindFirstPrinterChangeNotification-Funktion erstellt ein Änderungsbenachrichtigungsobjekt und gibt ein Handle an das Objekt zurück. Sie können dieses Handle dann in einem Aufruf einer der Wartefunktionen verwenden, um Änderungen am Drucker oder Druckserver zu überwachen.
FindNextPrinterChangeNotification
 Die FindNextPrinterChangeNotification-Funktion ruft Informationen zur neuesten Änderungsbenachrichtigung für ein Änderungsbenachrichtigungsobjekt ab, das einem Drucker oder Druckserver zugeordnet ist. Rufen Sie diese Funktion auf, wenn ein Wartevorgang für das Änderungsbenachrichtigungsobjekt erfüllt ist.
FreePrinterNotifyInfo
 Die Funktion FreePrinterNotifyInfo gibt einen systemseitig zugeordneten Puffer frei, der von der FindNextPrinterChangeNotification-Funktion erstellt wurde.

Druckerformularfunktionen

Diese Funktionen verwalten die von einem Drucker verwendeten Formulare.

Funktion BESCHREIBUNG
AddForm
 Die AddForm-Funktion fügt der Liste der verfügbaren Formulare, die für den angegebenen Drucker ausgewählt werden können, ein Formular hinzu.
DeleteForm
 Die DeleteForm-Funktion entfernt einen Formularnamen aus der Liste der unterstützten Formulare.
EnumForms
 Die EnumForms-Funktion listet die Formulare auf, die vom angegebenen Drucker unterstützt werden.
GetForm
 Die GetForm-Funktion ruft Informationen zu einem angegebenen Formular ab.
SetForm
 Die SetForm-Funktion legt die Formularinformationen für den angegebenen Drucker fest.

Diese Funktionen interagieren auf niedriger Ebene mit dem Druckspooler.

Funktion BESCHREIBUNG
CloseSpoolFileHandle
 Die CloseSpoolFileHandle-Funktion schließt ein Handle für eine Spooldatei, die dem Druckauftrag zugeordnet ist, der derzeit von der Anwendung übermittelt wird.
CommitSpoolData
 Die CommitSpoolData-Funktion benachrichtigt den Druckspooler, dass eine angegebene Datenmenge in eine angegebene Spooldatei geschrieben wurde und bereit ist, gerendert zu werden.
GetPrintExecutionData
 GetPrintExecutionData ruft den aktuellen Druckkontext ab.
GetSpoolFileHandle
 Die GetSpoolFileHandle-Funktion ruft ein Handle für die Spooldatei ab, die dem aktuell von der Anwendung übermittelten Auftrag zugeordnet ist.