MprConfigTransportGetInfo-Funktion (mprapi.h)

Artikel
08/24/2023

Die MprConfigTransportGetInfo-Funktion ruft die Konfiguration für das angegebene Transportprotokoll vom Router ab.

Syntax

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Parameter

[in] hMprConfig

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

[in] hRouterTransport

Behandeln Sie die abzurufende Transportprotokollkonfiguration. Rufen Sie dieses Handle ab, indem Sie MprConfigTransportCreate, MprConfigTransportGetHandle oder MprConfigTransportEnum aufrufen. Unterstützte Transportprotokolltypen sind unter Transportbezeichner aufgeführt.

[in, out, optional] ppGlobalInfo

Zeigen Sie bei der Eingabe auf eine Zeigervariable.

In der Ausgabe zeigt diese Zeigervariable auf einen Informationsheader, der globale Informationen für den Transport enthält. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten. Geben Sie diesen Puffer frei, indem Sie MprConfigBufferFree aufrufen.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, ruft die Funktion die globalen Informationen nicht ab.

[out, optional] lpdwGlobalInfoSize

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Größe des Puffers in Bytes, der über den ppGlobalInfo-Parameter zurückgegeben wird.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben. Wenn ppGlobalInfo jedoch nicht NULL ist, kann dieser Parameter nicht NULL sein.

[in, out, optional] ppClientInterfaceInfo

Zeigen Sie bei der Eingabe auf eine Zeigervariable.

In der Ausgabe zeigt dieser Zeiger auf einen Informationsheader, der Standardschnittstelleninformationen für Clientrouter für diesen Transport enthält. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten. Geben Sie den Puffer frei, indem Sie MprConfigBufferFree aufrufen.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, ruft die Funktion die Schnittstelleninformationen nicht ab.

[out, optional] lpdwClientInterfaceInfoSize

Zeiger auf eine DWORD-Variable . Diese Variable empfängt die Größe des Puffers in Bytes, die über den parameter ppClientInterfaceInfo zurückgegeben wird.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben. Wenn ppClientInterfaceInfo jedoch nicht NULL ist, kann dieser Parameter nicht NULL sein.

[in, out, optional] lplpwsDLLPath

Zeigen Sie bei der Eingabe auf einen Zeiger auf eine Unicode-Zeichenfolge mit Null-Beendigung.

Bei der Ausgabe empfängt die Unicode-Zeichenfolge den Namen der Router-Manager-DLL für den angegebenen Transport.

Dieser Parameter ist optional. Wenn die aufrufende Anwendung NULL für diesen Parameter angibt, ruft die Funktion den Namen der Router-Manager-DLL nicht ab.

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. hRouterTransport ist NULL ppGlobalInfo ist nicht NULL, aber lpdwGlobalInfoSize ist NULL. ppClientInterfaceInfo ist nicht NULL, aber lpdwClientInterfaceInfo ist NULL.
ERROR_UNKNOWN_PROTOCOL_ID	Die Transportprotokollkonfiguration, die hRouterTransport entspricht, wurde in der Routerkonfiguration nicht gefunden.
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 die Parameter pGlobalInfo, pClientInterfaceInfo und lpwsDLLPath alle NULL sind, tut die Funktion nichts und gibt den 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