MprAdminInterfaceEnum-Funktion (mprapi.h)

Artikel
02/29/2024

Die Funktion MprAdminInterfaceEnum listet alle Schnittstellen auf einem angegebenen Server auf.

Syntax

DWORD MprAdminInterfaceEnum(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  DWORD             dwLevel,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Parameter

[in] hMprServer

Verarbeiten Sie den Router, auf dem dieser Aufruf ausgeführt werden soll. Rufen Sie dieses Handle ab, indem Sie MprAdminServerConnect aufrufen.

[in] dwLevel

Ein DWORD-Wert, der das Format beschreibt, in dem die Informationen im lplpbBuffer-Parameter zurückgegeben werden. Muss Null sein.

[out] lplpbBuffer

Nach erfolgreicher Fertigstellung wird ein Zeiger auf ein Array von MPR_INTERFACE_0 Strukturen angezeigt. Geben Sie diesen Speicherpuffer frei, indem Sie MprAdminBufferFree aufrufen.

[in] dwPrefMaxLen

Gibt die bevorzugte maximale Länge der zurückgegebenen Daten (in 8-Bit-Bytes) an. Wenn dieser Parameter -1 ist, ist der zurückgegebene Puffer groß genug, um alle verfügbaren Informationen aufzunehmen.

[out] lpdwEntriesRead

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Schnittstellen, die von der aktuellen Position in der Enumeration aufgelistet wurden.

[out] lpdwTotalEntries

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Schnittstellen, die aus der aktuellen Fortsetzenposition hätten aufgezählt werden können.

[in] lpdwResumeHandle

Zeiger auf eine DWORD-Variable . Diese Variable gibt ein Resume-Handle an, das zum Fortsetzen der Enumeration verwendet werden kann. Das Handle sollte beim ersten Aufruf 0 sein und bei nachfolgenden Aufrufen unverändert bleiben. Wenn der Rückgabecode ERROR_MORE_DATA ist, kann der Aufruf mithilfe des Handles erneut ausgegeben werden, um weitere Daten abzurufen. Wenn das Handle bei der Rückgabe NULL ist, kann die Enumeration nicht fortgesetzt werden. Bei anderen Typen von Fehlerrückmeldungen ist dieses Handle ungültig.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, gibt die Funktion kein Fortsetzenhandle zurück.

Rückgabewert

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

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert	Bedeutung
ERROR_ACCESS_DENIED	Die aufrufende Anwendung verfügt nicht über ausreichende Berechtigungen.
ERROR_MORE_DATA	Weitere Informationen sind verfügbar; die Enumeration kann fortgesetzt werden.
ERROR_NOT_ENOUGH_MEMORY	Unzureichende Ressourcen, um den Vorgang abzuschließen.
ERROR_NOT_SUPPORTED	Der Wert von dwLevel ist ungültig.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	mprapi.h
Bibliothek	Mprapi.lib
DLL	Mprapi.dll

Weitere Informationen

MPR_INTERFACE_0

MprAdminBufferFree

MprAdminServerConnect

Routerverwaltungsfunktionen

Referenz zur Routerverwaltung