NetUseEnum-Funktion (lmuse.h)

Artikel
08/24/2023

Die NetUseEnum-Funktion listet alle aktuellen Verbindungen zwischen dem lokalen Computer und Den Ressourcen auf Remoteservern auf.

Sie können auch die Funktionen WNetOpenEnum und WNetEnumResource verwenden, um Netzwerkressourcen oder Verbindungen aufzulisten.

Syntax

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

Parameter

[in] UncServerName

Der UNC-Name des Computers, auf dem diese Funktion ausgeführt werden soll. Wenn der Parameter NULL ist, wird der lokale Computer verwendet. Wenn der angegebene UncServerName-Parameter ein Remotecomputer ist, muss der Remotecomputer RPC-Remoteaufrufe mithilfe des älteren Remotezugriffsprotokollmechanismus unterstützen.

Diese Zeichenfolge ist Unicode, wenn _WIN32_WINNT oder FORCE_UNICODE definiert sind.

[in] LevelFlags

Die Informationsebene der angeforderten Daten. Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
0	Gibt einen lokalen Gerätenamen und den Freigabenamen einer Remoteressource an. Der BufPtr-Parameter verweist auf ein Array von USE_INFO_0 Strukturen.
1	Gibt Informationen zur Verbindung zwischen einem lokalen Gerät und einer freigegebenen Ressource an, einschließlich verbindungs status und Typs. Der BufPtr-Parameter verweist auf ein Array von USE_INFO_1 Strukturen.
2	Gibt Informationen zur Verbindung zwischen einem lokalen Gerät und einer freigegebenen Ressource an. Zu den Informationen gehören die verbindungs-status, der Verbindungstyp, der Benutzername und der Domänenname. Der BufPtr-Parameter verweist auf ein Array von USE_INFO_2 Strukturen.

[out] BufPtr

Ein Zeiger auf den Puffer, der die Informationsstrukturen empfängt. Das Format dieser Daten hängt vom Wert des Parameters Level ab. Dieser Puffer wird vom System zugewiesen und muss mithilfe der NetApiBufferFree-Funktion freigegeben werden, wenn die Informationen nicht mehr benötigt werden. Beachten Sie, dass Sie den Puffer auch dann freigeben müssen, wenn die Funktion mit ERROR_MORE_DATA fehlschlägt.

[in] PreferedMaximumSize

Die bevorzugte maximale Länge der zurückzugebenden Daten in Bytes. Wenn MAX_PREFERRED_LENGTH angegeben ist, ordnet die Funktion den für die Daten erforderlichen Arbeitsspeicher zu. Wenn in diesem Parameter ein anderer Wert angegeben wird, kann die Anzahl von Bytes eingeschränkt werden, die die Funktion zurückgibt. Wenn die Puffergröße nicht ausreicht, um alle Einträge aufzunehmen, gibt die Funktion ERROR_MORE_DATA zurück. Weitere Informationen finden Sie unter Netzwerkverwaltungsfunktionspuffer und Netzwerkverwaltungsfunktionspufferlängen.

[out] EntriesRead

Ein Zeiger auf einen Wert, der die Anzahl der tatsächlich aufgelisteten Elemente empfängt.

[out] TotalEntries

Ein Zeiger auf einen Wert, der die Gesamtanzahl von Einträgen empfängt, die aus der aktuellen Position des Fortsetzens hätten aufgezählt werden können. Beachten Sie, dass Anwendungen diesen Wert nur als Hinweis betrachten sollten.

[in, out] ResumeHandle

Ein Zeiger auf einen Wert, der ein Resume-Handle enthält, das zum Fortsetzen der Suche verwendet wird. Das Handle sollte beim ersten Aufruf 0 sein und für nachfolgende Aufrufe unverändert bleiben. Wenn ResumeHandleNULL ist, wird kein Resume-Handle gespeichert.

Rückgabewert

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

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein Systemfehlercode. Eine Liste der Fehlercodes finden Sie unter Systemfehlercodes.

Rückgabecode	Beschreibung
ERROR_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger in den Parametern BufPtr oder entriesread übergeben wird.
ERROR_MORE_DATA	Es müssen weitere Daten zurückgegeben werden. Dieser Fehler wird zurückgegeben, wenn die Puffergröße nicht ausreicht, um alle Einträge aufzunehmen.
ERROR_NOT_SUPPORTED	Die Anforderung wird nicht unterstützt. Dieser Fehler wird zurückgegeben, wenn der UncServerName-Parameter nicht NULL war und der Remoteserver keine RPC-Remoteaufrufe mit dem älteren Remotezugriffsprotokollmechanismus unterstützt.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Zum Aufrufen der NetUseEnum-Funktion ist keine spezielle Gruppenmitgliedschaft erforderlich. Diese Funktion kann nicht auf einem Remoteserver ausgeführt werden, außer in Fällen der Abwärtskompatibilität mit dem älteren Remotezugriffsprotokoll.

Um Informationen zu einer Netzwerkverbindung abzurufen, können Sie die NetUseGetInfo-Funktion aufrufen.

Diese Funktion gilt nur für den Client server Message Block (LAN Manager Workstation). Die NetUseEnum-Funktion unterstützt keine DFS-Freigaben (Distributed File System). Verwenden Sie die Funktionen WNetOpenEnum, WNetEnumResource und WNetCloseEnum , um Freigaben mit einem anderen Netzwerkanbieter aufzulisten (z. B. WebDAV oder eine DFS-Freigabe).

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	lmuse.h (include Lm.h, Lmcons.h)
Bibliothek	Netapi32.lib
DLL	Netapi32.dll