MprConfigInterfaceTransportSetInfo 函数 (mprapi.h)

项目
08/24/2023

MprConfigInterfaceTransportSetInfo 函数更新指定接口和传输协议上的客户端的配置信息。

语法

DWORD MprConfigInterfaceTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterInterface,
  [in]           HANDLE hRouterIfTransport,
  [in, optional] LPBYTE pInterfaceInfo,
  [in, optional] DWORD  dwInterfaceInfoSize
);

parameters

[in] hMprConfig

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

[in] hRouterInterface

要在其中更新信息的接口配置的句柄。通过调用 MprConfigInterfaceCreate 或 MprConfigInterfaceEnum 获取此句柄。

[in] hRouterIfTransport

要在其中更新客户端信息的传输配置的句柄。通过调用 MprConfigInterfaceTransportAdd、 MprConfigInterfaceTransportGetHandle 或 MprConfigInterfaceTransportEnum 来获取此句柄。支持的传输协议类型列在传输标识符中。

[in, optional] pInterfaceInfo

指向信息标头的指针，该标头包含指定接口和传输上的客户端的配置信息。指定传输的路由器管理器解释此信息。使用信息标头函数可操作信息标头。

此参数是可选的。如果调用应用程序为此参数指定 NULL ，则该函数不会更新客户端的配置信息。

[in, optional] dwInterfaceInfoSize

指定 pInterfaceInfo 指向的数据的大小（以字节为单位）。

此参数是可选的;调用应用程序可能会为此参数指定零。但是，如果 pInterfaceInfo 不为 NULL，则此参数不能为零。有关详细信息，请参阅本主题后面的“备注”部分。

返回值

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

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

值	含义
ERROR_INVALID_PARAMETER	以下至少一个条件成立： hMprConfig 为 NULL。 hRouterInterface 为 NULL。 hRouterIfTransport 为 NULL。
ERROR_NO_SUCH_INTERFACE	hRouterInterface 指定的接口不再存在于路由器配置中，或者 hRouterInterface 指定的传输不再存在于接口上。
其他	使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

注解

如果 pInterfaceInfo 参数为 NULL， 则 MprConfigInterfaceTransportSetInfo 不执行任何操作，并立即返回值 NO_ERROR。

要求


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