MprConfigInterfaceGetInfo 函数 (mprapi.h)

项目
08/24/2023

MprConfigInterfaceGetInfo 函数从路由器检索指定接口的配置。

语法

DWORD MprConfigInterfaceGetInfo(
  [in]      HANDLE  hMprConfig,
  [in]      HANDLE  hRouterInterface,
  [in]      DWORD   dwLevel,
  [in, out] LPBYTE  *lplpBuffer,
  [out]     LPDWORD lpdwBufferSize
);

parameters

[in] hMprConfig

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

[in] hRouterInterface

要检索其信息的接口配置的句柄。通过调用 MprConfigInterfaceCreate、 MprConfigInterfaceGetHandle 或 MprConfigInterfaceEnum 获取此句柄。

[in] dwLevel

一个 DWORD 值，该值描述 在 lplpBuffer 参数中返回信息时采用的格式。 dwLevel 的可接受值包括 0、1、2 和 3，如下表所示。

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

[in, out] lplpBuffer

输入时为非 NULL 指针。

成功完成后，指向 MPR_INTERFACE_0数组的指针，MPR_INTERFACE_1，
MPR_INTERFACE_2或 MPR_INTERFACE_3 结构。 dwLevel 参数指示结构的类型。通过调用 MprConfigBufferFree 释放此缓冲区。

[out] lpdwBufferSize

指向 DWORD 变量的指针。此变量接收通过 lplpBuffer 返回的数据的大小（以字节为单位）。

返回值

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

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

值	含义
ERROR_INVALID_PARAMETER	以下至少一个条件成立： hMprConfig 为 NULL hRouterInterface 为 NULL dwLevel 不是 0、1、2 或 3。 lplpBuffer 为 NULL lpdwBufferSize 为 NULL
ERROR_NOT_ENOUGH_MEMORY	资源不足，无法完成操作。
ERROR_NO_SUCH_INTERFACE	路由器配置中不存在对应于 hRouterInterface 的接口。

要求


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