Partager via


Fonctions API du spouleur d’impression

L’API Spouleur d’impression contient les fonctions et les structures de données utilisées par les applications pour gérer le spouleur d’impression Windows, ainsi que les imprimantes et les travaux d’impression qu’il contrôle.

Les fonctions de l’API Spouleur d’impression sont divisées en groupes suivants :

Ces fonctions envoient des travaux d’impression à une imprimante et suivent et contrôlent les travaux d’impression dans le spouleur d’impression.

Fonction Description
AddJob
La fonction AddJob ajoute un travail d’impression à la liste des travaux d’impression qui peuvent être planifiés par le spouleur d’impression. La fonction récupère le nom du fichier que vous pouvez utiliser pour stocker le travail.
ClosePrinter
La fonction ClosePrinter ferme l’objet imprimante spécifié.
DocumentEvent
La fonction DocumentEvent est un gestionnaire d’événements pour les événements associés à l’impression d’un document.
DocumentProperties
La fonction DocumentProperties récupère ou modifie les informations d’initialisation de l’imprimante ou affiche une feuille de propriétés de configuration d’imprimante pour l’imprimante spécifiée.
EndDocPrinter
La fonction EndDocPrinter termine un travail d’impression pour l’imprimante spécifiée.
EndPagePrinter
La fonction EndPagePrinter avertit le spouleur d’impression que l’application se trouve à la fin d’une page dans un travail d’impression.
EnumJobs
La fonction EnumJobs récupère des informations sur un ensemble spécifié de travaux d’impression pour une imprimante spécifiée.
GetJob
La fonction GetJob récupère des informations sur un travail d’impression spécifié.
OpenPrinter
La fonction OpenPrinter récupère un handle dans l’imprimante ou le serveur d’impression spécifié ou d’autres types de handles dans le sous-système d’impression.
OpenPrinter2
Récupère un handle pour l’imprimante, le serveur d’impression ou d’autres types de handles spécifiés dans le sous-système d’impression, tout en définissant certaines des options d’imprimante.
ReportJobProcessingProgress
Indique au service Spouleur d’impression si un travail d’impression XPS est en cours de mise en file d’attente ou de rendu et quelle partie du traitement est en cours.
ScheduleJob
La fonction ScheduleJob demande que le spouleur d’impression planifie un travail d’impression spécifié pour l’impression.
SetJob
La fonction SetJob met en pause, reprend, annule ou redémarre un travail d’impression sur une imprimante spécifiée. Vous pouvez également utiliser la fonction SetJob pour définir des paramètres de travail d’impression, tels que la priorité du travail d’impression et le nom du document.
StartDocPrinter
La fonction StartDocPrinter avertit le spouleur d’impression qu’un document doit être mis en pool pour impression.
StartPagePrinter
La fonction StartPagePrinter avertit le spouleur qu’une page est sur le point d’être imprimée sur l’imprimante spécifiée.

Fonctions de l’interface utilisateur de l’imprimante

Ces fonctions affichent une interface utilisateur qui permet à l’utilisateur de sélectionner ou de configurer une imprimante.

Fonction Description
AdvancedDocumentProperties
La fonction AdvancedDocumentProperties affiche une boîte de dialogue de configuration d’imprimante pour l’imprimante spécifiée, ce qui permet à l’utilisateur de configurer cette imprimante.
ConfigurePort
La fonction ConfigurePort affiche la boîte de dialogue de configuration de port pour un port sur le serveur spécifié.
ConnectToPrinterDlg
La fonction ConnectToPrinterDlg affiche une boîte de dialogue qui permet aux utilisateurs de parcourir et de se connecter aux imprimantes d’un réseau. Si l’utilisateur sélectionne une imprimante, la fonction tente de créer une connexion à celle-ci ; si aucun pilote approprié n’est installé sur le serveur, l’utilisateur a la possibilité de créer une imprimante localement.
PrinterProperties
La fonction PrinterProperties affiche une feuille de propriétés printer-properties pour l’imprimante spécifiée.

Fonctions d’imprimante

Ces fonctions ajoutent et configurent les imprimantes utilisées par le spouleur d’impression.

Fonction Description
AbortPrinter
La fonction AbortPrinter supprime le fichier de pool d’une imprimante si l’imprimante est configurée pour le spoulage.
Addprinter
La fonction AddPrinter ajoute une imprimante à la liste des imprimantes prises en charge pour un serveur spécifié.
AddPrinterConnection
La fonction AddPrinterConnection ajoute une connexion à l’imprimante spécifiée pour l’utilisateur actuel.
AddPrinterConnection2
Ajoute une connexion à l’imprimante spécifiée pour l’utilisateur actuel et spécifie les détails de connexion.
DeletePrinter
La fonction DeletePrinter supprime l’objet imprimante spécifié.
DeletePrinterConnection
La fonction DeletePrinterConnection supprime une connexion à une imprimante qui a été établie par un appel à AddPrinterConnection ou ConnectToPrinterDlg.
DeletePrinterData
La fonction DeletePrinterData supprime les données de configuration spécifiées pour une imprimante. Les données de configuration d’une imprimante se composent d’un ensemble de valeurs nommées et typées. La fonction DeletePrinterData supprime l’une de ces valeurs, spécifiées par son nom de valeur.
DeletePrinterDataEx
La fonction DeletePrinterDataEx supprime une valeur spécifiée des données de configuration d’une imprimante. Les données de configuration d’une imprimante se composent d’un ensemble de valeurs nommées et typées stockées dans une hiérarchie de clés de Registre. La fonction supprime une valeur spécifiée sous une clé spécifiée.
DeletePrinterKey
La fonction DeletePrinterKey supprime une clé spécifiée et toutes ses sous-clés pour une imprimante spécifiée.
EnumPrinterData
La fonction EnumPrinterData énumère les données de configuration d’une imprimante spécifiée.
EnumPrinterDataEx
La fonction EnumPrinterDataEx énumère tous les noms de valeurs et les données d’une imprimante et d’une clé spécifiées.
EnumPrinterKey
La fonction EnumPrinterKey énumère les sous-clés d’une clé spécifiée pour une imprimante spécifiée.
EnumPrinters
La fonction EnumPrinters énumère les imprimantes, les serveurs d’impression, les domaines ou les fournisseurs d’impression disponibles.
FlushPrinter
La fonction FlushPrinter envoie une mémoire tampon à l’imprimante afin de la supprimer d’un état temporaire.
GetDefaultPrinter
La fonction GetDefaultPrinter récupère le nom de l’imprimante par défaut pour l’utilisateur actuel sur l’ordinateur local.
GetPrinter
La fonction GetPrinter récupère des informations sur une imprimante spécifiée.
GetPrinterData
La fonction GetPrinterData récupère les données de configuration de l’imprimante ou du serveur d’impression spécifié.
GetPrinterDataEx
La fonction GetPrinterDataEx récupère les données de configuration de l’imprimante ou du serveur d’impression spécifié. GetPrinterDataEx peut récupérer des valeurs stockées par la fonction SetPrinterData . En outre, GetPrinterDataEx peut récupérer des valeurs stockées sous une clé spécifiée par la fonction SetPrinterDataEx .
IsValidDevmode
La fonction IsValidDevmode vérifie que le contenu d’une structure DEVMODE est valide.
ReadPrinter
La fonction ReadPrinter récupère les données de l’imprimante spécifiée.
ResetPrinter
La fonction ResetPrinter spécifie le type de données et les valeurs de mode appareil à utiliser pour l’impression des documents envoyés par la fonction StartDocPrinter . Ces valeurs peuvent être remplacées à l’aide de la fonction SetJob après le démarrage de l’impression de documents.
SetDefaultPrinter
La fonction SetDefaultPrinter définit le nom de l’imprimante par défaut pour l’utilisateur actuel sur l’ordinateur local.
SetPort
La fonction SetPort définit les status associées à un port d’imprimante.
SetPrinter
La fonction SetPrinter définit les données d’une imprimante spécifiée ou définit l’état de l’imprimante spécifiée en suspendant l’impression, en reprenant l’impression ou en effaçant tous les travaux d’impression.
SetPrinterData
La fonction SetPrinterData définit les données de configuration d’une imprimante ou d’un serveur d’impression.
SetPrinterDataEx
La fonction SetPrinterDataEx définit les données de configuration d’une imprimante ou d’un serveur d’impression. La fonction stocke les données de configuration sous la clé de Registre de l’imprimante.
WritePrinter
La fonction WritePrinter avertit le spouleur d’impression que les données doivent être écrites sur l’imprimante spécifiée.

Fonctions de notification de modification de l’imprimante

Ces fonctions permettent à une application d’être avertie des modifications apportées aux status d’une imprimante.

Fonction Description
FindClosePrinterChangeNotification
La fonction FindClosePrinterChangeNotification ferme un objet de notification de modification créé en appelant la fonction FindFirstPrinterChangeNotification . L’imprimante ou le serveur d’impression associé à l’objet de notification de modification ne sera plus surveillé par cet objet.
FindFirstPrinterChangeNotification
La fonction FindFirstPrinterChangeNotification crée un objet de notification de modification et retourne un handle à l’objet. Vous pouvez ensuite utiliser ce handle dans un appel à l’une des fonctions d’attente pour surveiller les modifications apportées à l’imprimante ou au serveur d’impression.
FindNextPrinterChangeNotification
La fonction FindNextPrinterChangeNotification récupère des informations sur la notification de modification la plus récente pour un objet de notification de modification associé à une imprimante ou un serveur d’impression. Appelez cette fonction lorsqu’une opération d’attente sur l’objet de notification de modification est satisfaite.
FreePrinterNotifyInfo
La fonction FreePrinterNotifyInfo libère une mémoire tampon allouée par le système créée par la fonction FindNextPrinterChangeNotification .

Fonctions de formulaire d’imprimante

Ces fonctions gèrent les formulaires utilisés par une imprimante.

Fonction Description
AddForm
La fonction AddForm ajoute un formulaire à la liste des formulaires disponibles qui peuvent être sélectionnés pour l’imprimante spécifiée.
DeleteForm
La fonction DeleteForm supprime un nom de formulaire de la liste des formulaires pris en charge.
EnumForms
La fonction EnumForms énumère les formulaires pris en charge par l’imprimante spécifiée.
GetForm
La fonction GetForm récupère des informations sur un formulaire spécifié.
SetForm
La fonction SetForm définit les informations de formulaire pour l’imprimante spécifiée.

Ces fonctions interagissent avec le spouleur d’impression à un niveau faible.

Fonction Description
CloseSpoolFileHandle
La fonction CloseSpoolFileHandle ferme un handle à un fichier spool associé au travail d’impression actuellement soumis par l’application.
CommitSpoolData
La fonction CommitSpoolData informe le spouleur d’impression qu’une quantité spécifiée de données a été écrite dans un fichier de spouleur spécifié et qu’elle est prête à être rendue.
GetPrintExecutionData
GetPrintExecutionData récupère le contexte d’impression actuel.
GetSpoolFileHandle
La fonction GetSpoolFileHandle récupère un handle pour le fichier spool associé au travail actuellement soumis par l’application.