Partager via


CommitSpoolData, fonction

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.

Syntaxe

HANDLE CommitSpoolData(
  _In_ HANDLE hPrinter,
  _In_ HANDLE hSpoolFile,
       DWORD  cbCommit
);

Paramètres

hPrinter [in]

Handle de l’imprimante à laquelle le travail a été envoyé. Il doit s’agir du même handle que celui utilisé pour obtenir hSpoolFile avec GetSpoolFileHandle.

hSpoolFile [in]

Handle du fichier de pool en cours de modification. Lors du premier appel de CommitSpoolData, il doit s’agir du même handle que celui retourné par GetSpoolFileHandle. Les appels suivants à CommitSpoolData doivent passer le handle retourné par l’appel précédent. Consultez la section Notes.

cbCommit

Nombre d’octets validés dans le spouleur d’impression.

Valeur retournée

Si la fonction réussit, elle retourne un handle au fichier spool.

Si la fonction échoue, elle retourne INVALID_HANDLE_VALUE.

Notes

Les applications qui envoient un travail d’impression de spouleur peuvent appeler GetSpoolFileHandle , puis écrire directement des données dans le handle de fichier du pool en appelant WriteFile. Pour informer le spouleur d’impression que le fichier contient des données prêtes à être rendues, l’application doit appeler CommitSpoolData et fournir le nombre d’octets disponibles.

Si CommitSpoolData est appelé plusieurs fois, chaque appel doit utiliser le handle de fichier de pool retourné par l’appel précédent. Quand aucune autre donnée n’est écrite dans le fichier de spouleur, CloseSpoolFileHandle doit être appelé pour le handle de fichier retourné par le dernier appel à CommitSpoolData.

Avant d’appeler CommitSpoolData, les applications doivent définir le pointeur de fichier sur la position qu’il avait avant d’écrire les données dans le fichier. Dans le processus de rendu des données dans le fichier spouleur, le spouleur d’impression déplace le pointeur de fichier de pool cbCommit octets à partir de la valeur actuelle du pointeur de fichier.

Spécifications

Condition requise Valeur
Client minimal pris en charge
Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge
Windows Server 2008 [applications de bureau uniquement]
En-tête
Winspool.h (inclure Windows.h)
Bibliothèque
Winspool.lib
DLL
WinSpool.drv

Voir aussi

Impression

Fonctions API du spouleur d’impression

GetSpoolFileHandle

CloseSpoolFileHandle