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
);

參數

[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
程式庫	Mprapi.lib
Dll	Mprapi.dll