StartDocA, fonction (wingdi.h)

Article
11/20/2024

La fonction StartDoc démarre une tâche d’impression.

Syntaxe

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

Paramètres

[in] hdc

Handle vers le contexte de l’appareil pour la tâche d’impression.

[in] lpdi

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

Valeur de retour

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

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

Remarques

Remarque Il s’agit d’une fonction bloquante ou synchrone et 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’état 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 rendre l’application sans réponse.

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 fonction SetJob et fournissez cette valeur comme l’un des arguments requis.

Exemples

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

Note

L’en-tête wingdi.h définit StartDoc comme 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. Le mélange 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	wingdi.h (include Windows.h)
bibliothèque	Gdi32.lib
DLL	Gdi32.dll