MprConfigTransportSetInfo 函数 (mprapi.h)

项目
02/29/2024

MprConfigTransportSetInfo 函数更改指定路由器配置中指定传输协议的配置。

语法

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
);

参数

[in] hMprConfig

路由器配置的句柄。通过调用 MprConfigServerConnect 获取此句柄。

[in] hRouterTransport

正在更新的传输协议配置的句柄。通过调用 MprConfigTransportCreate、 MprConfigTransportGetHandle 或 MprConfigTransportEnum 获取此句柄。支持的传输协议类型列在传输标识符上。

[in, optional] pGlobalInfo

指向信息标头的指针，该信息标头指定传输协议的全局信息。传输的路由器管理器解释此信息。使用信息标头函数操作信息标头。

此参数是可选的;调用应用程序可以为此参数指定 NULL 。

[in, optional] dwGlobalInfoSize

指定 pGlobalInfo 指向的数据的大小（以字节为单位）。如果调用应用程序为 pGlobalInfo 指定 NULL，则调用应用程序应为此参数指定零。

[in, optional] pClientInterfaceInfo

指向指定客户端路由器的默认接口信息的信息标头的指针。此信息用于为此传输配置客户端路由器的动态接口。使用信息标头函数操作信息标头。

此参数是可选的;调用应用程序可以为此参数指定 NULL 。

[in, optional] dwClientInterfaceInfoSize

指定 pClientInterfaceInfo 指向的数据的大小（以字节为单位）。如果调用应用程序为 pClientInterfaceInfo 指定 NULL，则调用应用程序应为此参数指定零。

[in, optional] lpwsDLLPath

指向 以 null 结尾的 Unicode 字符串的指针，该字符串指定指定传输的路由器管理器 DLL 的名称。

此参数是可选的;调用应用程序可以为此参数指定 NULL 。

返回值

如果函数成功，则返回值NO_ERROR。有关详细信息，请参阅本主题后面的“备注”部分。

如果函数失败，则返回值为以下错误代码之一。

值	含义
ERROR_INVALID_PARAMETER	hMprConfig 参数为 NULL，hRouterTransport 参数为 NULL，或两者均为 NULL。
ERROR_UNKNOWN_PROTOCOL_ID	路由器配置中找不到对应于 hRouterTransport 的传输协议配置。
其他	使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

注解

使用 MprConfigTransportSetInfo 设置传输的全局信息、默认接口信息或传输的路由器管理器 DLL 的名称。

MprConfigTransportSetInfo 尝试按它们在参数列表中出现的顺序设置项：

全局信息。
客户端路由器的默认接口信息。
路由器管理器 DLL 名称。

如果 MprConfigTransportSetInfo 无法设置任一项，它将立即返回，而不会尝试设置其余项。

如果 pGlobalInfo、 pClientInterfaceInfo 和 lpwsDLLPath 参数均为 NULL，则函数不执行任何操作，返回值 NO_ERROR。

要求

要求	值
最低受支持的客户端	无受支持的版本
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	mprapi.h
Library	Mprapi.lib
DLL	Mprapi.dll