MprConfigInterfaceTransportGetInfo-Funktion (mprapi.h)

Artikel
08/24/2023

Die MprConfigInterfaceTransportGetInfo-Funktion ruft die Konfigurationsinformationen für den angegebenen Client auf der angegebenen Schnittstelle ab.

Syntax

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

Parameter

[in] hMprConfig

Verarbeiten Sie die Routerkonfiguration. Rufen Sie dieses Handle ab, indem Sie MprConfigServerConnect aufrufen.

[in] hRouterInterface

Behandeln Sie die Schnittstellenkonfiguration, aus der die angegebenen Clientinformationen abgerufen werden sollen. Rufen Sie dieses Handle ab, indem Sie MprConfigInterfaceCreate, MprConfigInterfaceGetHandle oder MprConfigInterfaceEnum aufrufen.

[in] hRouterIfTransport

Verarbeiten Sie die Transportkonfiguration, aus der die angegebenen Clientinformationen abgerufen werden sollen. Rufen Sie dieses Handle ab, indem Sie MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle oder MprConfigInterfaceTransportEnum aufrufen. Unterstützte Transportprotokolltypen sind unter Transportbezeichner aufgeführt.

[in, out, optional] ppInterfaceInfo

Zeigen Sie bei der Eingabe auf eine Zeigervariable.

In der Ausgabe verweist diese Zeigervariable auf einen Informationsheader, der Konfigurationsinformationen für den Client enthält. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten. Geben Sie diesen Arbeitsspeicher frei, indem Sie MprConfigBufferFree aufrufen.

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

[out, optional] lpdwInterfaceInfoSize

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Größe der Daten in Bytes, auf die von ppInterfaceInfo verwiesen wird.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben. Wenn ppInterfaceInfo jedoch nicht NULL ist, darf dieser Parameter nicht NULL sein. Weitere Informationen finden Sie im Abschnitt mit den Hinweisen weiter unten in diesem Thema.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR. Weitere Informationen finden Sie im Abschnitt mit den Hinweisen weiter unten in diesem Thema.

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

Wert	Bedeutung
ERROR_INVALID_PARAMETER	Es trifft eine der folgenden Bedingungen zu: hMprConfig ist NULL. hRouterInterface ist NULL. hRouterIfTransport ist NULL. ppInterfaceInfo ist nicht NULL, aber lpdwInterfaceInfoSize ist NULL.
ERROR_NO_SUCH_INTERFACE	Die von hRouterIfTransport angegebene Schnittstelle wurde in der Routerkonfiguration nicht gefunden, oder der von hRouterIfTransport angegebene Transport war für die angegebene Schnittstelle nicht aktiviert.
ERROR_NOT_ENOUGH_MEMORY	Unzureichende Ressourcen, um den Vorgang abzuschließen.
Andere	Verwenden Sie FormatMessage , um die Systemfehlermeldung abzurufen, die dem zurückgegebenen Fehlercode entspricht.

Hinweise

Wenn der ppInterfaceInfo-ParameterNULL ist, tut MprConfigInterfaceTransportGetInfo nichts und gibt sofort mit dem Wert NO_ERROR zurück.

Anforderungen


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