NPEnumResource-Funktion (npapi.h)
Führt eine Enumeration basierend auf einem von NPOpenEnum zurückgegebenen Handle aus.
Syntax
DWORD NPEnumResource(
[in] HANDLE hEnum,
[in, out] LPDWORD lpcCount,
[out] LPVOID lpBuffer,
[in, out] LPDWORD lpBufferSize
);
Parameter
[in] hEnum
Handle, das von einem NPOpenEnum-Aufruf abgerufen wurde.
[in, out] lpcCount
Zeiger auf die Anzahl der angeforderten Einträge. Es kann 0xFFFFFFFF sein, so viele Einträge wie möglich anzufordern. Wenn der Aufruf erfolgreich ist, erhält dieser Speicherort die Anzahl der tatsächlich gelesenen Einträge.
[out] lpBuffer
Zeiger auf den Puffer zum Empfangen des Enumerationsergebnisses, das als Array von NETRESOURCE-Einträgen zurückgegeben wird. Der Puffer ist bis zum nächsten Aufruf mit hEnum gültig.
[in, out] lpBufferSize
Zeiger auf die Größe des Puffers in Bytes, der bei der Eingabe an den Funktionsaufruf übergeben wird. Wenn der Puffer für nur einen Eintrag zu klein ist, sollte dieser beim Beenden die Anzahl der Bytes enthalten, die zum Lesen eines Eintrags erforderlich sind. Dieser Wert wird nur festgelegt, wenn der Rückgabecode WN_MORE_DATA ist.
Rückgabewert
Wenn die Funktion erfolgreich ist, sollte sie WN_SUCCESS zurückgeben. Der Aufrufer kann weiterhin NPEnumResource aufrufen, um die Enumeration fortzusetzen. Andernfalls sollte einer der folgenden Fehlercodes zurückgegeben werden.
Rückgabecode | Beschreibung |
---|---|
|
Keine weiteren Einträge. Die Enumeration wurde erfolgreich abgeschlossen. In diesem Fall ist der Inhalt des Rückgabepuffers lpBuffer nicht definiert. |
|
Der Puffer ist zu klein, um selbst einen einzelnen Eintrag aufzunehmen. |
|
hEnum ist kein gültiges Handle. |
|
Das Netzwerk ist nicht vorhanden. Diese Bedingung wird überprüft, bevor hEnum auf Gültigkeit getestet wird. |
Hinweise
Wenn diese Funktion aufgerufen wird, sollte der Anbieter den Puffer mit der angeforderten Anzahl von Einträgen (oder dem maximal zulässigen Wert) füllen. Die zurückgegebenen NETRESOURCE-Strukturen sollten sich wie ein Array solcher Strukturen zusammenhängend am Anfang des Puffers befinden. Die Zeiger in diesen Strukturen müssen auf Speicherorte innerhalb des Puffers verweisen. Daher sollten sich Daten, auf die von diesen Zeigern verwiesen wird, am Ende des Puffers nach dem Array von Strukturen befinden. Es liegt in der Verantwortung des Anbieters, diese Informationen korrekt zu verpacken.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps] |
Unterstützte Mindestversion (Server) | Windows Server 2003 [nur Desktop-Apps] |
Zielplattform | Windows |
Kopfzeile | npapi.h |