Freigeben über


DeletePort-Funktion

Die DeletePort-Funktion zeigt ein Dialogfeld an, in dem der Benutzer einen Portnamen löschen kann.

Syntax

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

Parameter

pName [in]

Ein Zeiger auf eine Zeichenfolge mit Nullende, die den Namen des Servers angibt, für den der Port gelöscht werden soll. Wenn dieser Parameter NULL ist, wird ein lokaler Port gelöscht.

hWnd [in]

Ein Handle für das übergeordnete Fenster des Dialogfelds zum Löschen des Ports.

pPortName [in]

Ein Zeiger auf eine null endende Zeichenfolge, die den Namen des Ports angibt, der gelöscht werden soll.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null.

Bemerkungen

Hinweis

Dies ist eine blockierende oder synchrone Funktion, die möglicherweise nicht sofort zurückgegeben wird. Wie schnell diese Funktion zurückgibt, hängt von Laufzeitfaktoren wie Netzwerk-status, Druckserverkonfiguration und Druckertreiberimplementierungsfaktoren ab, die beim Schreiben einer Anwendung schwer vorherzusagen sind. Das Aufrufen dieser Funktion aus einem Thread, der die Interaktion mit der Benutzeroberfläche verwaltet, könnte dazu führen, dass die Anwendung nicht mehr reagiert.

Eine Anwendung kann die Namen gültiger Ports abrufen, indem sie die EnumPorts-Funktion aufruft .

Die DeletePort-Funktion gibt einen Fehler zurück, wenn ein Drucker derzeit mit dem angegebenen Port verbunden ist.

Der Aufrufer der DeletePort-Funktion muss SERVER_ACCESS_ADMINISTER Zugriff auf den Server haben, mit dem der Port verbunden ist.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows 2000 Server [nur Desktop-Apps]
Header
Winspool.h (Einschließen von Windows.h)
Bibliothek
Winspool.lib
DLL
Winspool.drv
Unicode- und ANSI-Name
DeletePortW (Unicode) und DeletePortA (ANSI)

Siehe auch

Drucken

Druckspooler-API-Funktionen

AddPort

EnumPorts