SetPort fonction)

La fonction SetPort définit l’état associé à un port d’imprimante.

Syntaxe

BOOL SetPort(
  _In_ LPTSTR pName,
  _In_ LPTSTR pPortName,
  _In_ DWORD  dwLevel,
  _In_ LPBYTE pPortInfo
);

Paramètres

pname [ dans]

Pointeur vers une chaîne se terminant par zéro qui spécifie le nom du serveur d’impression auquel le port est connecté. Affectez la valeur null à ce paramètre si le port se trouve sur l’ordinateur local.

pPortName [ dans]

Pointeur vers une chaîne se terminant par zéro qui spécifie le nom du port d’imprimante.

dwLevel [ dans]

Spécifie le type de structure vers lequel pointe le paramètre pPortInfo .

Cette valeur doit être 3, ce qui correspond à une structure de données de port _ informations _ 3 .

pPortInfo [ dans]

Pointeur vers une structure d' informations de port _ _ 3 qui contient les informations d’état de port à définir.

Valeur renvoyée

Si la fonction est réussie, 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 de blocage ou synchrone qui peut ne pas être renvoyée immédiatement. La vitesse à laquelle cette fonction est retournée dépend des facteurs d’exécution tels que l’état du réseau, la configuration du serveur d’impression et les facteurs d’implémentation des pilotes 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 faire que l’application semble ne pas répondre.

L’appelant de la fonction SetPort doit s’exécuter en tant qu’administrateur. En outre, si l’appelant est un moniteur de port ou un moniteur de langage, il doit appeler RevertToSelf pour arrêter l’emprunt d’identité avant d’appeler SetPort.

Tous les programmes qui appellent SetPort doivent disposer d’un accès serveur _ _ administrer l’accès au serveur auquel le port est connecté.

Lorsque vous définissez une valeur d’état de port d’imprimante avec la valeur de gravité _ _ erreur de type état du port _ , le spouleur d’impression cesse d’envoyer des travaux au port. Le spouleur d’impression reprend l’envoi des travaux au port lorsque l’état du port est effacé par un autre appel à SetPort.

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
SetPortW (Unicode) et SetPortA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

_Informations sur le port _ 3