MprAdminInterfaceGetInfo 函式 (mprapi.h)

發行項
03/05/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
程式庫	Mprapi.lib
Dll	Mprapi.dll