MprAdminPortEnum-Funktion (mprapi.h)

Artikel
02/29/2024

Die MprAdminPortEnum-Funktion listet alle aktiven Ports in einer bestimmten Verbindung oder alle Ports auf, die für die Verwendung verfügbar sind oder derzeit von RAS verwendet werden.

Syntax

DWORD MprAdminPortEnum(
  [in]  RAS_SERVER_HANDLE hRasServer,
  [in]  DWORD             dwLevel,
  [in]  HANDLE            hRasConnection,
  [out] LPBYTE            *lplpbBuffer,
  [in]  DWORD             dwPrefMaxLen,
  [out] LPDWORD           lpdwEntriesRead,
  [out] LPDWORD           lpdwTotalEntries,
  [in]  LPDWORD           lpdwResumeHandle
);

Parameter

[in] hRasServer

Ein Handle für den RAS-Server, dessen Ports aufgelistet werden sollen. Um dieses Handle zu erhalten, rufen Sie MprAdminServerConnect auf.

[in] dwLevel

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

[in] hRasConnection

Ein Handle für eine Verbindung, für die die aktiven Ports aufgelistet werden. Wenn dieser Parameter INVALID_HANDLE_VALUE ist, werden alle Ports aufgelistet, die von RRAS verwendet oder zur Verwendung verfügbar sind. Rufen Sie MprAdminConnectionEnum auf, um dieses Handle zu erhalten.

[out] lplpbBuffer

Bei erfolgreicher Fertigstellung ein Zeiger auf ein Array von RAS_PORT_0 Strukturen, das den Port beschreibt. Geben Sie diesen Arbeitsspeicher frei, indem Sie MprAdminBufferFree aufrufen.

[in] dwPrefMaxLen

Ein -Wert, der die bevorzugte maximale Länge der zurückgegebenen Daten in 8-Bit-Bytes angibt. Wenn dieser Parameter -1 ist, ist der zurückgegebene Puffer groß genug, um alle verfügbaren Daten zu enthalten.

[out] lpdwEntriesRead

Ein Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Ports, die von der aktuellen Position des Fortsetzens aufgezählt werden.

[out] lpdwTotalEntries

Ein Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Ports, die von der aktuellen Position des Fortsetzens hätten aufgezählt werden können.

[in] lpdwResumeHandle

Ein Zeiger auf eine DWORD-Variable . Bei erfolgreicher Ausführung gibt dieser Parameter ein Handle an, das zum Fortsetzen der Enumeration verwendet werden kann. Dieser Parameter sollte beim ersten Aufruf null sein und bei nachfolgenden Aufrufen unverändert bleiben. Wenn der Rückgabecode ERROR_MORE_DATA ist, kann der Aufruf mit dem Handle erneut ausgeführt werden, um weitere Daten abzurufen. Wenn das Handle bei der Rückgabe NULL ist, kann die Enumeration nicht fortgesetzt werden. Dieses Handle ist für andere Fehlerrückmeldungen ungültig.

Rückgabewert

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

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

Wert	Bedeutung
ERROR_ACCESS_DENIED	Die aufrufende Anwendung verfügt nicht über ausreichende Berechtigungen.
ERROR_DDM_NOT_RUNNING	Der DDM-Manager (Demand Dial Manager) wird nicht ausgeführt, möglicherweise weil der Dynamische Schnittstellen-Manager (DIM) nur für die Ausführung in einem LAN konfiguriert ist.
ERROR_INVALID_PARAMETER	Mindestens einer der folgenden Parameter ist NULL oder verweist nicht auf gültigen Arbeitsspeicher: lplpBuffer, lpdwEntriesRead oder lpdwTotalEntries.
ERROR_MORE_DATA	Bei diesem Aufruf wurden nicht alle Daten zurückgegeben. Um zusätzliche Daten zu erhalten, rufen Sie die Funktion erneut mithilfe des Handles auf, das im IpdwResumeHandle-Parameter zurückgegeben wurde.
ERROR_NOT_SUPPORTED	Der dwLevel-Parameter ist nicht 0 (null).
ERROR_INVALID_HANDLE	Der hConnection-Parameter ist NULL.
Andere	Ein Fehler von "MprError.h", "RasError.h" oder "WinError.h".

Hinweise

Wenn RRAS redistributable installiert ist, ist diese Funktion unter Windows NT 4.0 verfügbar. Die Version von Mprapi.dll, die mit der RRAS-Verteilerfunktion bereitgestellt wird, exportiert die Funktion jedoch als RasAdminPortEnum anstelle von MprAdminPortEnum. Wenn Sie RRAS redistributable verwenden, verwenden Sie daher LoadLibrary und GetProcAddress , um auf diese Funktion zuzugreifen.

Anforderungen

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