WNetEnumResourceA-Funktion (winnetwk.h)

Artikel
11/20/2024

Die WNetEnumResource-Funktion setzt eine Aufzählung von Netzwerkressourcen fort, die durch einen Aufruf der WNetOpenEnum-Funktion gestartet wurde.

Syntax

DWORD WNetEnumResourceA(
  [in]      HANDLE  hEnum,
  [in, out] LPDWORD lpcCount,
  [out]     LPVOID  lpBuffer,
  [in, out] LPDWORD lpBufferSize
);

Parameter

[in] hEnum

Behandeln, das eine Enumerationsinstanz identifiziert. Dieses Handle muss von der WNetOpenEnum--Funktion zurückgegeben werden.

[in, out] lpcCount

Zeigen Sie auf eine Variable, die die Anzahl der angeforderten Einträge angibt. Wenn die angeforderte Zahl –1 lautet, gibt die Funktion so viele Einträge wie möglich zurück.

Wenn die Funktion erfolgreich ist, enthält die variable, auf die dieser Parameter verweist, die Anzahl der tatsächlich gelesenen Einträge.

[out] lpBuffer

Zeigen Sie auf den Puffer, der die Enumerationsergebnisse empfängt. Die Ergebnisse werden als Array von NETRESOURCE- Strukturen zurückgegeben. Beachten Sie, dass der zugewiesene Puffer groß genug sein muss, um die Strukturen sowie die Zeichenfolgen, auf die ihre Member verweisen, zu enthalten. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

Der Puffer ist gültig, bis der nächste Aufruf das durch den hEnum Parameter angegebene Handle verwendet. Die Reihenfolge der NETRESOURCE- Strukturen im Array ist nicht vorhersehbar.

[in, out] lpBufferSize

Zeiger auf eine Variable, die die Größe des lpBuffer--Parameters in Byte angibt. Wenn der Puffer zu klein ist, um sogar einen Eintrag zu empfangen, empfängt dieser Parameter die erforderliche Größe des Puffers.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert einer der folgenden Werte.

Rückgabecode	Beschreibung
NO_ERROR	Die Aufzählung war erfolgreich, und der Puffer enthält die angeforderten Daten. Die aufrufende Anwendung kann weiterhin WNetEnumResource- aufrufen, um die Enumeration abzuschließen.
ERROR_NO_MORE_ITEMS	Es gibt keine weiteren Einträge. Der Pufferinhalt ist nicht definiert.

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

Rückgabecode	Beschreibung
ERROR_MORE_DATA	Weitere Einträge stehen bei nachfolgenden Aufrufen zur Verfügung. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".
ERROR_INVALID_HANDLE	Das vom hEnum Parameter angegebene Handle ist ungültig.
ERROR_NO_NETWORK	Das Netzwerk ist nicht verfügbar. (Diese Bedingung wird getestet, bevor hEnum auf Gültigkeit geprüft wird.)
ERROR_EXTENDED_ERROR	Es ist ein netzwerkspezifischer Fehler aufgetreten. Rufen Sie zum Abrufen einer Beschreibung des Fehlers die WNetGetLastError--Funktion auf.

Bemerkungen

Die funktion WNetEnumResource führt keine Aufzählung der mit einer Freigabe verbundenen Benutzer durch; Sie können die NetConnectionEnum--Funktion aufrufen, um diese Aufgabe auszuführen. Rufen Sie zum Aufzählen ausgeblendeter Freigaben die NetShareEnum--Funktion auf.

Eine Anwendung kann den lpBuffer Parameter nicht auf null festlegen und die erforderliche Puffergröße aus dem lpBufferSize Parameter abrufen. Stattdessen sollte die Anwendung einen Puffer mit einer angemessenen Größe zuweisen – 16 KB ist typisch – und verwenden Sie den Wert lpBufferSize für die Fehlererkennung.

Beispiele

Ein Codebeispiel, das eine anwendungsdefinierte Funktion veranschaulicht, die alle Ressourcen in einem Netzwerk aufzählt, finden Sie unter Aufzählen von Netzwerkressourcen.

Anmerkung

Der winnetwk.h-Header definiert WNetEnumResource 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