StartDocW, fonction (wingdi.h)

Article
08/27/2023

La fonction StartDoc démarre un travail d’impression.

Syntaxe

int StartDocW(
  [in] HDC            hdc,
  [in] const DOCINFOW *lpdi
);

Paramètres

[in] hdc

Handle vers le contexte de l’appareil pour le travail d’impression.

[in] lpdi

Pointeur vers une structure DOCINFO contenant le nom du fichier document et le nom du fichier de sortie.

Valeur retournée

Si la fonction réussit, la valeur de retour est supérieure à zéro. Cette valeur est l’identificateur du travail d’impression pour le document.

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

Remarques

Note Il s’agit d’une fonction bloquante ou synchrone qui peut ne pas être retournée immédiatement. La rapidité avec laquelle cette fonction retourne dépend de facteurs d’exécution tels que l’status réseau, la configuration du serveur d’impression et l’implémentation du pilote d’imprimante, facteurs 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 donner l’impression que l’application ne répond pas.

Les applications doivent appeler la fonction StartDoc immédiatement avant de commencer un travail d’impression. L’utilisation de cette fonction garantit que les documents multipage ne sont pas entrelacés avec d’autres travaux d’impression.

Les applications peuvent utiliser la valeur retournée par StartDoc pour récupérer ou définir la priorité d’un travail d’impression. Appelez la fonction GetJob ou SetJob et fournissez cette valeur comme l’un des arguments requis.

Exemples

Pour obtenir un exemple de programme qui utilise cette fonction, consultez Guide pratique pour imprimer à l’aide de l’API d’impression GDI.

Notes

L’en-tête wingdi.h définit StartDoc comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wingdi.h (inclure Windows.h)
Bibliothèque	Gdi32.lib
DLL	Gdi32.dll