Partager via


Fonction EnumPrintProcessors

La fonction EnumPrintProcessors énumère les processeurs d’impression installés sur le serveur spécifié.

Syntaxe

BOOL EnumPrintProcessors(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pPrintProcessorInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Paramètres

pName [in]

Pointeur vers une chaîne terminée par null qui spécifie le nom du serveur sur lequel résident les processeurs d’impression. Si ce paramètre a la valeur NULL, les processeurs d’impression locaux sont énumérés.

pEnvironment [in]

Pointeur vers une chaîne terminée par null qui spécifie l’environnement (par exemple, Windows x86, Windows IA64 ou Windows x64). Si ce paramètre a la valeur NULL, l’environnement actuel de l’application appelante et de l’ordinateur client (et non de l’application de destination et du serveur d’impression) est utilisé.

Niveau [in]

Type d’informations retournées dans la mémoire tampon pPrintProcessorInfo . Ce paramètre doit être 1.

pPrintProcessorInfo [out]

Pointeur vers une mémoire tampon qui reçoit un tableau de structures PRINTPROCESSOR_INFO_1 . Chaque structure décrit un processeur d’impression disponible. La mémoire tampon doit être suffisamment grande pour recevoir le tableau de structures et toutes les chaînes vers lesquelles les membres de la structure pointent.

Pour déterminer la taille de mémoire tampon requise, appelez EnumPrintProcessors avec cbBuf défini sur zéro. EnumPrintProcessors échoue, GetLastError retourne ERROR_INSUFFICIENT_BUFFER et le paramètre pcbNeeded retourne la taille, en octets, de la mémoire tampon requise pour contenir le tableau des structures et leurs données.

cbBuf [in]

Taille, en octets, de la mémoire tampon pointée par pPrintProcessorInfo.

pcbNeeded [out]

Pointeur vers une variable qui reçoit le nombre d’octets copiés dans la mémoire tampon pPrintProcessorInfo si la fonction réussit. Si la mémoire tampon est trop petite, la fonction échoue et la variable reçoit le nombre d’octets requis.

pcReturned [out]

Pointeur vers une variable qui reçoit le nombre de structures retournées dans la mémoire tampon pPrintProcessorInfo .

Valeur retournée

Si la fonction réussit, la valeur de retour est une valeur différente de zéro.

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

Notes

Notes

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 les facteurs d’implémentation du pilote d’imprimante qui sont 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.

Spécifications

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
EnumPrintProcessorsW (Unicode) et EnumPrintProcessorsA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

AddPrintProcessor

EnumPrintProcessorDatatypes

PRINTPROCESSOR_INFO_1