MprAdminInterfaceGetHandle 函式 (mprapi.h)
MprAdminInterfaceGetHandle函式會擷取指定介面的控制碼。
語法
DWORD MprAdminInterfaceGetHandle(
[in] MPR_SERVER_HANDLE hMprServer,
[in] LPWSTR lpwsInterfaceName,
[out] HANDLE *phInterface,
[in] BOOL fIncludeClientInterfaces
);
參數
[in] hMprServer
處理要在其中執行此呼叫的路由器。 呼叫 MprAdminServerConnect以取得此控制碼。
[in] lpwsInterfaceName
Null終止 Unicode 字串的指標,指定要擷取之介面的名稱。
[out] phInterface
HANDLE變數的指標,該變數會接收由 lpwsInterfaceName所指定的介面控制碼。
[in] fIncludeClientInterfaces
指定函式是否傳回用戶端介面。 如果此參數為FALSE,則會在搜尋名稱為lpwsInterfaceName的介面時忽略類型ROUTER_IF_TYPE_CLIENT介面。 如果此參數為 TRUE ,且具有指定名稱的介面存在, MprAdminInterfaceGetHandle 會傳回 類型為 ROUTER_IF_TYPE_CLIENT之介面的控制碼。 因為有數個類型 為 ROUTER_IF_TYPE_CLIENT的介面,所以控制碼會參考以 lpwsInterfaceName所指定名稱找到的第一個介面。
傳回值
如果函式成功,傳回值會 NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
值 | 意義 |
---|---|
|
呼叫的應用程式沒有足夠的許可權。 |
|
沒有由 lpwsInterfaceName指定名稱的介面。 |
|
傳遞至伺服器的控制碼為 Null。 |
|
lpwsInterfaceName 為 Null。 |
需求
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | mprapi.h |
程式庫 | Mprapi.lib |
Dll | Mprapi.dll |