MprAdminInterfaceConnect 函式 (mprapi.h)

發行項
08/24/2023

MprAdminInterfaceConnect函式會建立與指定 WAN 介面的連線。

語法

DWORD MprAdminInterfaceConnect(
  [in] MPR_SERVER_HANDLE hMprServer,
  [in] HANDLE            hInterface,
  [in] HANDLE            hEvent,
  [in] BOOL              fSynchronous
);

參數

[in] hMprServer

處理要在其中執行此呼叫的路由器。藉由呼叫 MprAdminServerConnect來取得此控制碼。

[in] hInterface

介面的控制碼。這個控制碼是從先前呼叫 MprAdminInterfaceCreate取得。

[in] hEvent

處理嘗試連接介面之後發出訊號的事件。函式會起始連接嘗試，並立即傳回。發出事件訊號之後，您可以呼叫 MprAdminInterfaceGetInfo來取得連線嘗試的結果。

如果此參數為 Null，且 fBlocking 為 TRUE，則此呼叫是同步的，也就是說，在連線嘗試完成之前，函式不會傳回。

如果hMprServer指定遠端路由器，則呼叫應用程式必須指定此參數的Null。

[in] fSynchronous

如果 hEvent 為 Null 且此參數設定為 TRUE，則函式不會在連線嘗試完成之前傳回。

如果 hEvent 為 Null，且此參數設定為 FALSE，則函式會立即傳回。 PENDING 的傳回值表示已成功起始連線嘗試。

如果 hEvent 不是 Null，則會忽略此參數。

傳回值

如果函式成功，傳回值會NO_ERROR。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

值	意義
ERROR_ACCESS_DENIED	呼叫的應用程式沒有足夠的許可權。
ERROR_ALREADY_CONNECTING	此介面上已經進行連線。
ERROR_DDM_NOT_RUNNING	[需求撥號管理器] (DDM) 未執行。
ERROR_INTERFACE_DISABLED	介面目前已停用。
ERROR_INTERFACE_HAS_NO_DEVICES	此介面沒有介面卡可用。
ERROR_INVALID_HANDLE	hInterface值無效。
ERROR_SERVICE_IS_PAUSED	需求撥號服務目前已暫停。
等待	介面正在連接。如果已指定呼叫應用程式，則呼叫端應用程式必須在 hEvent 控制碼上等候。發出事件訊號之後，您可以呼叫 MprAdminInterfaceGetInfo來取得連線的狀態和任何相關聯的錯誤。

備註

下表摘要說明 hEvent 與 fBlocking之間的關聯性。

hEvent	fBlocking	結果
事件控制碼	忽略	呼叫會立即傳回。 PENDING 的傳回值表示嘗試已成功起始。等候 hEvent。發出 hEvent 訊號時，請使用 MprAdminInterfaceGetInfo 來判斷連線嘗試的成功或失敗。
NULL	TRUE	呼叫不會在連線嘗試完成之前傳回。
NULL	FALSE	呼叫會立即傳回。 PENDING 的傳回值表示嘗試已成功起始。

需求


最低支援的用戶端	都不支援
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	mprapi.h
程式庫	Mprapi.lib
Dll	Mprapi.dll