MprAdminInterfaceGetInfo 函数 (mprapi.h)

项目
02/29/2024

MprAdminInterfaceGetInfo 函数检索指定服务器上的指定接口的信息。

语法

DWORD MprAdminInterfaceGetInfo(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] DWORD             dwLevel,
  [in] LPBYTE            *lplpbBuffer
);

参数

[in] hMprServer

要查询的路由器的句柄。此句柄是从上一次调用 MprAdminServerConnect 获取的。

[in] hInterface

上一次调用 MprAdminInterfaceCreate 获取的接口的句柄。

[in] dwLevel

一个 DWORD 值，该值描述在 lplpbBuffer 参数中构建信息的格式。 dwLevel 的可接受值包括 0、1、2 和 3，如下表所示。

值	结构格式
0	MPR_INTERFACE_0
1	MPR_INTERFACE_1
2	MPR_INTERFACE_2
3	Windows Server 2008 或更高版本： MPR_INTERFACE_3

值 1、2 和 3 仅对 ROUTER_CONNECTION_STATE 类型的接口有效。

[in] lplpbBuffer

指向 MPR_INTERFACE_0的指针， MPR_INTERFACE_1，
MPR_INTERFACE_2或 MPR_INTERFACE_3 结构。 dwLevel 参数指示结构的类型。通过调用 MprAdminBufferFree 释放此内存。

返回值

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

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

值	含义
ERROR_ACCESS_DENIED	调用应用程序没有足够的权限。
ERROR_INVALID_LEVEL	dwLevel 为 2，但接口不支持该级别。例如，MPR_INTERFACE_X结构中定义的接口类型不是 IF_TYPE_FULL_ROUTER。
ERROR_INVALID_HANDLE	hInterface 值无效。
ERROR_INVALID_PARAMETER	lplpbBuffer 参数为 NULL。
ERROR_NOT_ENOUGH_MEMORY	资源不足，无法完成操作。
ERROR_NOT_SUPPORTED	dwLevel 值无效。

要求

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