API-funktioner för utskriftshanteraren
API:et för utskriftshanteraren innehåller de funktioner och datastrukturer som program använder för att hantera Windows-utskriftshanteraren och de skrivare och utskriftsjobb som den styr.
Funktionerna i API:et för utskriftshanteraren är indelade i följande grupper:
- utskriftsjobbfunktioner
- skrivargränssnittsfunktioner
- Skrivarfunktioner
- Meddelandefunktioner för skrivarändring
- skrivarformulärfunktioner
- Print Spooler Functions
Utskriftsjobbfunktioner
Dessa funktioner skickar utskriftsjobb till en skrivare och spårar och styr utskriftsjobben i utskriftshanteraren.
Funktion | Beskrivning |
---|---|
AddJob |
Funktionen AddJob lägger till ett utskriftsjobb i listan över utskriftsjobb som kan schemaläggas av utskriftshanteraren. Funktionen hämtar namnet på den fil som du kan använda för att lagra jobbet. |
ClosePrinter |
Funktionen ClosePrinter stänger det angivna skrivarobjektet. |
DocumentEvent |
Funktionen DocumentEvent är en händelsehanterare för händelser som är associerade med utskrift av ett dokument. |
DocumentProperties |
Funktionen DocumentProperties hämtar eller ändrar information om skrivarinitiering eller visar ett egenskapsblad för skrivarkonfiguration för den angivna skrivaren. |
EndDocPrinter |
Funktionen EndDocPrinter avslutar ett utskriftsjobb för den angivna skrivaren. |
EndPagePrinter |
Funktionen EndPagePrinter meddelar utskriftshanteraren att programmet är i slutet av en sida i ett utskriftsjobb. |
Uppräkning |
Funktionen EnumJobs hämtar information om en angiven uppsättning utskriftsjobb för en angiven skrivare. |
GetJob |
Funktionen GetJob hämtar information om ett angivet utskriftsjobb. |
OpenPrinter |
Funktionen OpenPrinter hämtar ett handtag till den angivna skrivaren eller utskriftsservern eller andra typer av referenser i utskriftsundersystemet. |
OpenPrinter2 |
Hämtar ett handtag till den angivna skrivaren, utskriftsservern eller andra typer av handtag i utskriftsundersystemet, samtidigt som några av skrivaralternativen anges. |
ReportJobProcessingProgress |
Rapporterar till utskriftshanteraren om ett XPS-utskriftsjobb är i buffringsfasen eller renderingsfasen och vilken del av bearbetningen som pågår för närvarande. |
ScheduleJob |
Funktionen ScheduleJob begär att utskriftshanteraren schemalägger ett angivet utskriftsjobb för utskrift. |
SetJob |
Funktionen SetJob pausar, återupptar, avbryter eller startar om ett utskriftsjobb på en angiven skrivare. Du kan också använda funktionen SetJob för att ange utskriftsjobbparametrar, till exempel utskriftsjobbets prioritet och dokumentnamnet. |
StartDocPrinter |
Funktionen StartDocPrinter meddelar utskriftshanteraren att ett dokument ska buffras för utskrift. |
StartPagePrinter |
Funktionen StartPagePrinter meddelar spolaren att en sida håller på att skrivas ut på den angivna skrivaren. |
Funktioner för skrivargränssnitt
Dessa funktioner visar ett användargränssnitt som gör att användaren kan välja eller konfigurera en skrivare.
Funktion | Beskrivning |
---|---|
AdvancedDocumentProperties |
Funktionen AdvancedDocumentProperties visar en dialogruta för skrivarkonfiguration för den angivna skrivaren så att användaren kan konfigurera skrivaren. |
ConfigurePort |
Funktionen ConfigurePort visar dialogrutan portkonfiguration för en port på den angivna servern. |
ConnectToPrinterDlg |
Funktionen ConnectToPrinterDlg visar en dialogruta där användarna kan bläddra och ansluta till skrivare i ett nätverk. Om användaren väljer en skrivare försöker funktionen skapa en anslutning till den. Om en lämplig drivrutin inte är installerad på servern får användaren möjlighet att skapa en skrivare lokalt. |
PrinterProperties |
Funktionen PrinterProperties visar ett egenskapsblad för skrivaregenskaper för den angivna skrivaren. |
Skrivarfunktioner
Dessa funktioner lägger till och konfigurerar de skrivare som utskriftshanteraren använder.
Funktion | Beskrivning |
---|---|
AbortPrinter |
Funktionen AbortPrinter tar bort en skrivarpoolfil om skrivaren är konfigurerad för buffring. |
AddPrinter |
Funktionen AddPrinter lägger till en skrivare i listan över skrivare som stöds för en angiven server. |
AddPrinterConnection |
Funktionen AddPrinterConnection lägger till en anslutning till den angivna skrivaren för den aktuella användaren. |
AddPrinterConnection2 |
Lägger till en anslutning till den angivna skrivaren för den aktuella användaren och anger anslutningsinformation. |
DeletePrinter |
Funktionen DeletePrinter tar bort det angivna skrivarobjektet. |
DeletePrinterConnection |
Funktionen DeletePrinterConnection tar bort en anslutning till en skrivare som upprättades av ett anrop till AddPrinterConnection eller ConnectToPrinterDlg. |
DeletePrinterData |
Funktionen DeletePrinterData tar bort angivna konfigurationsdata för en skrivare. En skrivares konfigurationsdata består av en uppsättning namngivna och inskrivna värden. Funktionen DeletePrinterData tar bort ett av dessa värden, som anges med dess värdenamn. |
DeletePrinterDataEx |
Funktionen DeletePrinterDataEx tar bort ett angivet värde från konfigurationsdata för en skrivare. En skrivares konfigurationsdata består av en uppsättning namngivna och inskrivna värden som lagras i en hierarki med registernycklar. Funktionen tar bort ett angivet värde under en angiven nyckel. |
DeletePrinterKey |
Funktionen DeletePrinterKey tar bort en angiven nyckel och alla dess undernycklar för en angiven skrivare. |
EnumPrinterData |
Funktionen EnumPrinterData räknar upp konfigurationsdata för en angiven skrivare. |
EnumPrinterDataEx |
Funktionen EnumPrinterDataEx räknar upp alla värdenamn och data för en angiven skrivare och nyckel. |
EnumPrinterKey |
Funktionen EnumPrinterKey räknar upp undernycklarna för en angiven nyckel för en angiven skrivare. |
Uppräkningsskrivare |
Funktionen EnumPrinters räknar upp tillgängliga skrivare, utskriftsservrar, domäner eller utskriftsproviders. |
FlushPrinter |
Funktionen FlushPrinter skickar en buffert till skrivaren för att rensa den från ett tillfälligt tillstånd. |
GetDefaultPrinter |
Funktionen GetDefaultPrinter hämtar skrivarnamnet på standardskrivaren för den aktuella användaren på den lokala datorn. |
GetPrinter |
Funktionen GetPrinter hämtar information om en angiven skrivare. |
GetPrinterData |
Funktionen GetPrinterData hämtar konfigurationsdata för den angivna skrivaren eller utskriftsservern. |
GetPrinterDataEx |
Funktionen GetPrinterDataEx hämtar konfigurationsdata för den angivna skrivaren eller utskriftsservern.
GetPrinterDataEx kan hämta värden som lagras av funktionen SetPrinterData. Dessutom kan GetPrinterDataEx hämta värden som lagras under en angiven nyckel av funktionen SetPrinterDataEx. |
IsValidDevmode |
Funktionen IsValidDevmode verifierar att innehållet i en DEVMODE-struktur är giltigt. |
ReadPrinter |
Funktionen ReadPrinter hämtar data från den angivna skrivaren. |
ResetPrinter |
Funktionen ResetPrinter anger de värden för datatyp och enhetsläge som ska användas för att skriva ut dokument som skickas av funktionen StartDocPrinter. Dessa värden kan åsidosättas med hjälp av funktionen SetJob när dokumentutskriften har startats. |
SetDefaultPrinter |
Funktionen SetDefaultPrinter anger skrivarnamnet på standardskrivaren för den aktuella användaren på den lokala datorn. |
SetPort |
Funktionen SetPort anger statusen som är associerad med en skrivarport. |
SetPrinter |
Funktionen SetPrinter anger data för en angiven skrivare eller anger tillståndet för den angivna skrivaren genom att pausa utskrift, återuppta utskrift eller rensa alla utskriftsjobb. |
SetPrinterData |
Funktionen SetPrinterData anger konfigurationsdata för en skrivare eller utskriftsserver. |
SetPrinterDataEx |
Funktionen SetPrinterDataEx anger konfigurationsdata för en skrivare eller utskriftsserver. Funktionen lagrar konfigurationsdata under skrivarens registernyckel. |
WritePrinter |
Funktionen WritePrinter meddelar utskriftshanteraren att data ska skrivas till den angivna skrivaren. |
Meddelandefunktioner för skrivarändring
Med de här funktionerna kan ett program meddelas om ändringar i skrivarens status.
Funktion | Beskrivning |
---|---|
FindClosePrinterChangeNotification |
Funktionen FindClosePrinterChangeNotification stänger ett ändringsmeddelandeobjekt som skapats genom att anropa funktionen FindFirstPrinterChangeNotification. Skrivaren eller utskriftsservern som är associerad med ändringsmeddelandeobjektet övervakas inte längre av objektet. |
FindFirstPrinterChangeNotification |
Funktionen FindFirstPrinterChangeNotification skapar ett ändringsmeddelandeobjekt och returnerar ett handtag till objektet. Du kan sedan använda handtaget i ett anrop till någon av väntefunktionerna för att övervaka ändringar i skrivaren eller utskriftsservern. |
FindNextPrinterChangeNotification |
Funktionen FindNextPrinterChangeNotification hämtar information om det senaste ändringsmeddelandet för ett ändringsmeddelandeobjekt som är associerat med en skrivare eller utskriftsserver. Anropa den här funktionen när en vänteåtgärd på ändringsmeddelandeobjektet är uppfyllt. |
FreePrinterNotifyInfo |
Funktionen FreePrinterNotifyInfo frigör en systemallokerad buffert som skapats av funktionen FindNextPrinterChangeNotification. |
Skrivarformulärfunktioner
Dessa funktioner hanterar de formulär som används av en skrivare.
Funktion | Beskrivning |
---|---|
AddForm |
Funktionen AddForm lägger till ett formulär i listan över tillgängliga formulär som kan väljas för den angivna skrivaren. |
DeleteForm |
Funktionen DeleteForm tar bort ett formulärnamn från listan över formulär som stöds. |
EnumForms |
Funktionen EnumForms räknar upp de formulär som stöds av den angivna skrivaren. |
GetForm |
Funktionen GetForm hämtar information om ett angivet formulär. |
SetForm |
Funktionen SetForm anger formulärinformationen för den angivna skrivaren. |
Utskriftshanterarens funktioner
Dessa funktioner interagerar med utskriftshanteraren på en låg nivå.
Funktion | Beskrivning |
---|---|
CloseSpoolFileHandle |
Funktionen CloseSpoolFileHandle stänger ett handtag till en spoolfil som är associerad med utskriftsjobbet som för närvarande skickas av programmet. |
CommitSpoolData |
Funktionen CommitSpoolData meddelar utskriftshanteraren att en angiven mängd data har skrivits till en angiven spoolfil och är redo att återges. |
GetPrintExecutionData |
GetPrintExecutionData hämtar den aktuella utskriftskontexten. |
GetSpoolFileHandle |
Funktionen GetSpoolFileHandle hämtar ett handtag för den spoolfil som är associerad med det jobb som för närvarande skickas av programmet. |