WNetCancelConnection2A-Funktion (winnetwk.h)

Artikel
11/20/2024

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 WNetCancelConnection2A(
  [in] LPCSTR lpName,
  [in] DWORD  dwFlags,
  [in] BOOL   fForce
);

Parameter

[in] lpName

Zeiger auf eine Konstante NULL--terminated-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

Verbindungsart. Die folgenden Werte sind definiert.

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

[in] fForce

Gibt an, ob die Verbindung unterbrochen werden soll, wenn geöffnete Dateien oder Aufträge in der Verbindung vorhanden sind. Wenn dieser Parameter FALSEist, schlägt die Funktion fehl, wenn geöffnete Dateien oder Aufträge vorhanden 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 dauerhafte 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 zum Abrufen einer Beschreibung des Fehlers die WNetGetLastError--Funktion auf.
ERROR_NOT_CONNECTED	Der durch den parameter 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.

Bemerkungen

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 die lokal eindeutigen Bezeichnersoder LUID, die einer Anmeldesitzung zugeordnet ist.) Dies kann sich auf Anwendungen auswirken, die eine der WNet-Funktionen aufrufen, um einen Netzlaufwerkbuchstaben unter einer Benutzeranmeldung zu erstellen, aber abfragen Sie vorhandene Netzlaufwerkbuchstaben unter einer anderen Benutzeranmeldung. Ein Beispiel für diese Situation könnte sein, wenn die zweite Anmeldung eines Benutzers innerhalb einer Anmeldesitzung erstellt wird, z. B. durch Aufrufen der CreateProcessAsUser--Funktion, und die zweite Anmeldung führt eine Anwendung aus, 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 noch vorhanden ist und das Beispiel auf jede Anmeldesitzung angewendet werden kann, einschließlich einer Terminaldienste-Sitzung. 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.

Anmerkung

Der winnetwk.h-Header definiert WNetCancelConnection2 als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, 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
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winnetwk.h
Library	Mpr.lib
DLL-	Mpr.dll