Partager via


AddPort, fonction

La fonction AddPort ajoute le nom d’un port à la liste des ports pris en charge. La fonction AddPort est exportée par le moniteur de port.

Syntaxe

BOOL AddPort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pMonitorName
);

Paramètres

pName [in]

Pointeur vers une chaîne sans fin qui spécifie le nom du serveur auquel le port est connecté. Si ce paramètre a la valeur NULL, le port est local.

hWnd [in]

Handle de la fenêtre parente de la boîte de dialogue AddPort .

pMonitorName [in]

Pointeur vers une chaîne sans terminaison qui spécifie le moniteur associé au port.

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.

La fonction AddPort parcoure le réseau pour rechercher des ports existants et affiche une boîte de dialogue pour l’utilisateur. La fonction AddPort doit valider le nom de port entré par l’utilisateur en appelant EnumPorts pour s’assurer qu’aucun nom en double n’existe.

L’appelant de la fonction AddPort doit avoir SERVER_ACCESS_ADMINISTER accès au serveur auquel le port est connecté.

Pour ajouter un port sans afficher de boîte de dialogue, appelez la fonction XcvData au lieu de AddPort. Pour plus d’informations sur XcvData, consultez microsoft Windows Driver Development Kit (DDK).

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
Spoolss.dll
Noms Unicode et ANSI
AddPortW (Unicode) et AddPortA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

DeletePort

EnumPorts

SetPort