MprConfigInterfaceTransportGetInfo 函数 (mprapi.h)

项目
08/24/2023

MprConfigInterfaceTransportGetInfo 函数检索指定接口上指定客户端的配置信息。

语法

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

parameters

[in] hMprConfig

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

[in] hRouterInterface

要从中检索指定客户端信息的接口配置的句柄。通过调用 MprConfigInterfaceCreate、 MprConfigInterfaceGetHandle 或 MprConfigInterfaceEnum 获取此句柄。

[in] hRouterIfTransport

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

[in, out, optional] ppInterfaceInfo

输入时，指向指针变量的指针。

输出时，此指针变量指向包含客户端配置信息的信息标头。使用信息标头函数可操作信息标头。通过调用 MprConfigBufferFree 释放此内存。

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

[out, optional] lpdwInterfaceInfoSize

指向 DWORD 变量的指针。此变量接收 ppInterfaceInfo 指向的数据的大小（以字节为单位）。

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

返回值

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

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

值	含义
ERROR_INVALID_PARAMETER	下列情况之一存在： hMprConfig 为 NULL。 hRouterInterface 为 NULL。 hRouterIfTransport 为 NULL。 ppInterfaceInfo 不为 NULL，但 lpdwInterfaceInfoSize 为 NULL。
ERROR_NO_SUCH_INTERFACE	在路由器配置中找不到 hRouterIfTransport 指定的接口，或者在指定的接口上未启用 hRouterIfTransport 指定的传输。
ERROR_NOT_ENOUGH_MEMORY	资源不足，无法完成操作。
其他	使用 FormatMessage 检索与返回的错误代码对应的系统错误消息。

注解

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

要求


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