StartDocPrinter, fonction

La fonction StartDocPrinter avertit le spouleur d’impression qu’un document doit être enroulé pour l’impression.

Syntaxe

DWORD StartDocPrinter(
  _In_ HANDLE hPrinter,
  _In_ DWORD  Level,
  _In_ LPBYTE pDocInfo
);

Paramètres

hPrinter [in]

Poignée à l’imprimante. Utilisez la fonction OpenPrinter ou AddPrinter pour récupérer un handle d’imprimante.

Niveau [in]

Version de la structure à laquelle pointe pDocInfo . Cette valeur doit être 1.

pDocInfo [in]

Pointeur vers une structure DOC_INFO_1 qui décrit le document à imprimer.

Valeur retournée

Si la fonction réussit, la valeur de retour identifie le travail d’impression.

Si la fonction échoue, la valeur de retour est égale à zéro.

Notes

Notes

Il s’agit d’une fonction bloquante ou synchrone et peut ne pas retourner immédiatement. La rapidité de cette fonction dépend de facteurs d’exécution tels que l’état réseau, la configuration du serveur d’impression et les facteurs d’implémentation du pilote d’imprimante difficiles à prédire lors de l’écriture d’une application. L’appel de cette fonction à partir d’un thread qui gère l’interaction avec l’interface utilisateur peut rendre l’application non réponse.

La séquence classique d’une tâche d’impression est la suivante :

  1. Pour commencer un travail d’impression, appelez StartDocPrinter.
  2. Pour commencer chaque page, appelez StartPagePrinter.
  3. Pour écrire des données dans une page, appelez WritePrinter.
  4. Pour terminer chaque page, appelez EndPagePrinter.
  5. Répétez 2, 3 et 4 pour autant de pages que nécessaire.
  6. Pour terminer le travail d’impression, appelez EndDocPrinter.

Notez que l’appel de StartPagePrinter et EndPagePrinter peut ne pas être nécessaire, par exemple si le type de données d’impression inclut les informations de page.

Lorsqu’une page d’un fichier en pool dépasse environ 350 Mo, elle peut ne pas imprimer et ne pas envoyer de message d’erreur. Par exemple, cela peut se produire lors de l’impression de fichiers EMF volumineux. La limite de taille de page dépend de nombreux facteurs, notamment la quantité de mémoire virtuelle disponible, la quantité de mémoire allouée par les processus appelant et la quantité de fragmentation dans le tas de processus.

Exemples

Pour obtenir un exemple de programme qui utilise cette fonction, consultez How To: Print Using the GDI Print API.

Configuration requise

Condition requise Valeur
Client minimal pris en charge
Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge
Windows 2000 Server [applications de bureau uniquement]
En-tête
Winspool.h (inclure Windows.h)
Bibliothèque
Winspool.lib
DLL
Winspool.drv
Noms Unicode et ANSI
StartDocPrinterW (Unicode) et StartDocPrinterA (ANSI)

Voir aussi

AddJob

DOC_INFO_1

DOC_INFO_2

EndDocPrinter

EndPagePrinter

OpenPrinter

Impression

Fonctions API du spouleur d’impression

StartDocPrinter

StartPagePrinter

WritePrinter