MprAdminTransportGetInfo 函数 (mprapi.h)

  • 项目

MprAdminTransportGetInfo 函数检索指定传输的全局信息、默认客户端接口信息或两者。

语法

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

参数

[in] hMprServer

从中检索信息的路由器的句柄。 此句柄是从上一次调用 MprAdminServerConnect 获取的。

[in] dwTransportId

描述要检索的传输类型的 DWORD 值。 下表列出了 dwTransportId 的可接受值。

值 传输 (协议系列)
PID_ATALK AppleTalk
PID_IP Internet 协议版本 4
PID_IPX Internet 数据包交换
PID_NBF NetBIOS 帧协议
PID_IPV6 Windows Server 2008 或更高版本：Internet 协议版本 6

[out, optional] ppGlobalInfo

指向指针变量的指针。 此变量指向接收此传输的全局信息的信息标头。 使用 信息标头函数 可操作信息标头。

通过调用 MprAdminBufferFree 释放此内存。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则该函数不会检索全局信息。

[out, optional] lpdwGlobalInfoSize

指向 DWORD 变量的指针。 此变量接收传输的全局信息的大小（以字节为单位）。

[out, optional] ppClientInterfaceInfo

指向指针变量的指针。 此变量指向此传输的默认客户端接口信息。 通过调用 MprAdminBufferFree 释放此内存。

此参数是可选的。 如果调用应用程序为此参数指定 NULL ，则该函数不会检索客户端接口信息。

[out, optional] lpdwClientInterfaceInfoSize

指向 DWORD 变量的指针。 此变量接收客户端接口信息的大小（以字节为单位）。

返回值

如果函数成功，则返回值NO_ERROR。

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

值 含义
ERROR_ACCESS_DENIED
 调用应用程序没有足够的权限。
ERROR_INVALID_PARAMETER
 下列情况之一存在：
  • ppGlobalInfo 参数和 ppClientInterfaceInfo 参数均为 NULL。
  • ppGlobalInfo 参数不指向有效的内存。
  • ppClientInterfaceInfo 参数不指向有效的内存。
ERROR_NOT_ENOUGH_MEMORY
 资源不足，无法完成操作。
ERROR_UNKNOWN_PROTOCOL_ID
 dwTransportId 值与任何已安装的传输不匹配。

注解

ppGlobalInfo 和 ppClientInterfaceInfo 参数不能同时为 NULL。

要求

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

另请参阅

MprAdminBufferFree

MprAdminServerConnect

MprAdminTransportSetInfo

路由器管理功能

路由器管理参考