MprConfigTransportEnum-Funktion (mprapi.h)

Artikel
08/24/2023

Die MprConfigTransportEnum-Funktion listet die auf dem Router konfigurierten Transporte auf.

Syntax

DWORD MprConfigTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

Parameter

[in] hMprConfig

Handle mit der Routerkonfiguration für die Transporte. Rufen Sie dieses Handle ab, indem Sie MprConfigServerConnect aufrufen.

[in] dwLevel

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

[in, out] lplpBuffer

Bei der Eingabe ein Nicht-NULL-Zeiger .

Bei erfolgreicher Fertigstellung ein Zeiger auf ein Array von MPR_TRANSPORT_0 Strukturen. Geben Sie diesen Speicherpuffer frei, indem Sie MprConfigBufferFree 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 zu enthalten.

[out] lpdwEntriesRead

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Einträge, die von der aktuellen Position des Lebenslaufs aufgezählt wurden.

[out] lpdwTotalEntries

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Gesamtzahl der Einträge, die aus der aktuellen Position des Lebenslaufs hätten aufgezählt werden können.

[in, out, optional] lpdwResumeHandle

Zeiger auf eine DWORD-Variable .

Bei der Eingabe sollte das Handle beim ersten Aufruf null sein und bei nachfolgenden Aufrufen unverändert bleiben.

Bei der Ausgabe enthält diese Variable ein Resume-Handle, das zum Fortsetzen der Enumeration verwendet wird. Wenn das Handle NULL ist, ist die Enumeration abgeschlossen.

Wenn in der Enumeration ein Fehler auftritt, ist dieses Handle ungültig.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, gibt die Funktion kein Resume-Handle 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_INVALID_PARAMETER	Mindestens eine der folgenden Optionen muss zutreffen: hMprConfig ist NULL. dwLevel ist nicht null. lplpBuffer ist NULL. dwPrefMaxLen ist kleiner als die Größe einer einzelnen MPR_TRANSPORT_0-Struktur . lpdwEntriesRead ist NULL. lpdwTotalEntries ist NULL.
ERROR_NOT_ENOUGH_MEMORY	Unzureichende Ressourcen zum Abschließen des Vorgangs.
ERROR_NO_MORE_ITEMS	Von der aktuellen Position des Lebenslaufs sind keine einträge mehr verfügbar.
Andere	Verwenden Sie FormatMessage , um die Systemfehlermeldung abzurufen, die dem zurückgegebenen Fehlercode entspricht.

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

FormatMessage

MprConfigBufferFree

MprConfigServerConnect

Routerkonfigurationsfunktionen

Referenz zur Routerverwaltung

Freigeben über