WNetCancelConnection2W-Funktion (winnetwk.h)

Artikel
08/27/2023

Die WNetCancelConnection2-Funktion bricht eine vorhandene Netzwerkverbindung ab. Sie können die Funktion auch aufrufen, um gespeicherte Netzwerkverbindungen zu entfernen, die derzeit nicht verbunden sind.

Die WNetCancelConnection2-Funktion ersetzt die WNetCancelConnection-Funktion .

Syntax

DWORD WNetCancelConnection2W(
  [in] LPCWSTR lpName,
  [in] DWORD   dwFlags,
  [in] BOOL    fForce
);

Parameter

[in] lpName

Zeiger auf eine konstante NULL-beendete Zeichenfolge, die den Namen des umgeleiteten lokalen Geräts oder der Remotenetzwerkressource angibt, von der die Verbindung getrennt werden soll.

Wenn dieser Parameter ein umgeleitetes lokales Gerät angibt, bricht die Funktion nur die angegebene Geräteumleitung ab. Wenn der Parameter eine Remotenetzwerkressource angibt, werden alle Verbindungen ohne Geräte abgebrochen.

[in] dwFlags

Verbindungstyp. Die folgenden Werte werden definiert.

Wert	Bedeutung
0	Das System aktualisiert keine Informationen zur Verbindung. Wenn die Verbindung in der Registrierung als persistent gekennzeichnet wurde, stellt das System die Verbindung bei der nächsten Anmeldung wieder her. Wenn die Verbindung nicht als persistent markiert wurde, ignoriert die Funktion die Einstellung des CONNECT_UPDATE_PROFILE Flags.
CONNECT_UPDATE_PROFILE	Das System aktualisiert das Benutzerprofil mit der Information, dass die Verbindung nicht mehr dauerhaft ist. Das System stellt diese Verbindung bei nachfolgenden Anmeldevorgängen nicht wieder her. (Das Trennen von Ressourcen mithilfe von Remotenamen hat keine Auswirkungen auf persistente Verbindungen.)

[in] fForce

Gibt an, ob die Trennung erfolgen soll, wenn in der Verbindung offene Dateien oder Aufträge vorhanden sind. Wenn dieser Parameter FALSE ist, schlägt die Funktion fehl, wenn dateien oder Aufträge geöffnet sind.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein Systemfehlercode, z. B. einer der folgenden Werte.

Rückgabecode	Beschreibung
ERROR_BAD_PROFILE	Das Benutzerprofil weist ein falsches Format auf.
ERROR_CANNOT_OPEN_PROFILE	Das System kann das Benutzerprofil nicht öffnen, um persistente Verbindungen zu verarbeiten.
ERROR_DEVICE_IN_USE	Das Gerät wird von einem aktiven Prozess verwendet und kann nicht getrennt werden.
ERROR_EXTENDED_ERROR	Es ist ein netzwerkspezifischer Fehler aufgetreten. Rufen Sie die WNetGetLastError-Funktion auf, um eine Beschreibung des Fehlers zu erhalten.
ERROR_NOT_CONNECTED	Der vom lpName-Parameter angegebene Name ist kein umgeleitetes Gerät, oder das System ist derzeit nicht mit dem durch den Parameter angegebenen Gerät verbunden.
ERROR_OPEN_FILES	Es gibt geöffnete Dateien, und der fForce-Parameter ist FALSE.

Hinweise

Windows Server 2003 und Windows XP: Die WNet-Funktionen erstellen und löschen Netzwerklaufwerkbuchstaben im MS-DOS-Gerätenamespace, der einer Anmeldesitzung zugeordnet ist, da MS-DOS-Geräte durch AuthenticationID identifiziert werden. (Eine AuthenticationID ist der lokal eindeutige Bezeichner oder LUID, der einer Anmeldesitzung zugeordnet ist.) Dies kann sich auf Anwendungen auswirken, die eine der WNet-Funktionen aufrufen, um einen Netzwerklaufwerkbuchstaben unter einer Benutzeranmeldung zu erstellen, aber nach vorhandenen Netzlaufwerkbuchstaben unter einer anderen Benutzeranmeldung abfragen. Ein Beispiel für diese Situation kann sein, wenn die zweite Anmeldung eines Benutzers innerhalb einer Anmeldesitzung erstellt wird, z. B. durch Aufrufen der CreateProcessAsUser-Funktion , und die zweite Anmeldung eine Anwendung ausführt, die die GetLogicalDrives-Funktion aufruft . GetLogicalDrives gibt keine Netzwerklaufwerkbuchstaben zurück, die von einer WNet-Funktion unter der ersten Anmeldung erstellt wurden. Beachten Sie, dass im vorherigen Beispiel die erste Anmeldesitzung weiterhin vorhanden ist und das Beispiel auf jede Anmeldesitzung, einschließlich einer Terminaldienstesitzung, angewendet werden kann. Weitere Informationen finden Sie unter Definieren eines MS-DOS-Gerätenamens.

Beispiele

Ein Codebeispiel, das veranschaulicht, wie eine Verbindung mit einer Netzwerkressource mit einem Aufruf der WNetCancelConnection2-Funktion abgebrochen wird, finden Sie unter Abbrechen einer Netzwerkverbindung.

Hinweis

Der winnetwk.h-Header definiert WNetCancelConnection2 als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winnetwk.h
Bibliothek	Mpr.lib
DLL	Mpr.dll