DeletePort, fonction

La fonction DeletePort affiche une boîte de dialogue qui permet à l’utilisateur de supprimer un nom de port.

Syntaxe

BOOL DeletePort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pPortName
);

Paramètres

pName [in]

Pointeur vers une chaîne à terminaison zéro qui spécifie le nom du serveur pour lequel le port doit être supprimé. Si ce paramètre a la valeur NULL, un port local est supprimé.

hWnd [in]

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

pPortName [in]

Pointeur vers une chaîne à terminaison zéro qui spécifie le nom du port à supprimer.

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.

Une application peut récupérer les noms des ports valides en appelant la fonction EnumPorts .

La fonction DeletePort retourne une erreur si une imprimante est actuellement connectée au port spécifié.

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

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	DeletePortW (Unicode) et DeletePortA (ANSI)

Voir aussi

Impression

Fonctions API du spouleur d’impression

AddPort

EnumPorts