MprConfigTransportSetInfo-Funktion (mprapi.h)

Artikel
08/24/2023

Die MprConfigTransportSetInfo-Funktion ändert die Konfiguration für das angegebene Transportprotokoll in der angegebenen Routerkonfiguration.

Syntax

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

Parameter

[in] hMprConfig

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

[in] hRouterTransport

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

[in, optional] pGlobalInfo

Zeiger auf einen Informationsheader, der globale Informationen für das Transportprotokoll angibt. Der Router-Manager für den Transport interpretiert diese Informationen. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben.

[in, optional] dwGlobalInfoSize

Gibt die Größe der Daten in Bytes an, auf die pGlobalInfo verweist. Wenn die aufrufende Anwendung NULL für pGlobalInfo angibt, sollte die aufrufende Anwendung null für diesen Parameter angeben.

[in, optional] pClientInterfaceInfo

Zeiger auf einen Informationsheader, der Standardschnittstelleninformationen für Clientrouter angibt. Die Informationen werden verwendet, um dynamische Schnittstellen für Clientrouter für diesen Transport zu konfigurieren. Verwenden Sie die Informationsheaderfunktionen , um Informationsheader zu bearbeiten.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben.

[in, optional] dwClientInterfaceInfoSize

Gibt die Größe der Daten in Bytes an, auf die pClientInterfaceInfo verweist. Wenn die aufrufende Anwendung NULL für pClientInterfaceInfo angibt, sollte die aufrufende Anwendung null für diesen Parameter angeben.

[in, optional] lpwsDLLPath

Zeiger auf eine Mit NULL endende Unicode-Zeichenfolge, die den Namen der Router-Manager-DLL für den angegebenen Transport angibt.

Dieser Parameter ist optional. Die aufrufende Anwendung kann NULL für diesen Parameter angeben.

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	Der hMprConfig-Parameter ist NULL, der hRouterTransport-Parameterist NULL, oder beide sind NULL.
ERROR_UNKNOWN_PROTOCOL_ID	Die Transportprotokollkonfiguration, die hRouterTransport entspricht, wurde in der Routerkonfiguration nicht gefunden.
Andere	Verwenden Sie FormatMessage , um die Systemfehlermeldung abzurufen, die dem zurückgegebenen Fehlercode entspricht.

Hinweise

Verwenden Sie MprConfigTransportSetInfo , um die globalen Informationen des Transports, Standardschnittstelleninformationen oder den Namen der Router-Manager-DLL für den Transport festzulegen.

MprConfigTransportSetInfo versucht, die Elemente in der Reihenfolge festzulegen, in der sie in der Parameterliste angezeigt werden:

Globale Informationen.
Standardschnittstelleninformationen für Clientrouter.
Name der Router-Manager-DLL.

Wenn MprConfigTransportSetInfo eines der Elemente nicht festlegen kann, wird sofort zurückgegeben, ohne zu versuchen, die verbleibenden Elemente festzulegen.

Wenn die Parameter pGlobalInfo, pClientInterfaceInfo und lpwsDLLPath alle NULL sind, bewirkt die Funktion nichts und gibt den Wert NO_ERROR zurück.

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