RasGetSubEntryHandleA 函式 (ras.h)

發行項
03/01/2024

RasGetSubEntryHandle 函式會擷取多連結連接之指定子項目的連接句柄。

語法

DWORD RasGetSubEntryHandleA(
  [in]  HRASCONN   unnamedParam1,
  [in]  DWORD      unnamedParam2,
  [out] LPHRASCONN unnamedParam3
);

參數

[in] unnamedParam1

指定 RasDial 函式針對多連結電話簿專案所傳回的 HRASCONN 連線句柄。

[in] unnamedParam2

指定電話簿專案的有效子專案索引。

[out] unnamedParam3

HRASCONN 變數的指標，該變數會接收代表子實體連接的連接句柄。

傳回值

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

如果函式失敗，則傳回值是下列其中一個錯誤碼，或來自路由和遠端訪問錯誤碼或 Winerror.h 的值。

值	意義
ERROR_INVALID_HANDLE	hRasConn 線上句柄不代表連線的電話簿專案。
ERROR_PORT_NOT_OPEN	hRasConn 和 dwSubEntry 參數有效，但指定的子實體未連接。
ERROR_NO_MORE_ITEMS	dwSubEntry 所指定的值超過電話簿專案的子項目數目上限。

備註

hRasConn 參數中指定的連接句柄是指整個多連結連線，但 *lphRasConn 參數中傳回的連接句柄只會參考子連線。在任何接受 hRasConn 參數的函式中使用子聯機句柄，包括 RasHangUp、 RasGetConnectStatus 和 RasGetProjectionInfoEx 函式。 RasGetProjectionInfo 針對多鏈接專案所傳回的投影資訊，與每個子實體連接句柄相同，如同主要連接句柄一樣。

您可以在 RasGetSubEntryHandle 所傳回的句柄上呼叫 RasHangUp，以終止多連結連線中的單一連結。不過，您無法使用 RasGetConnectStatus 來判斷連結是否終止;即使連結成功終止， RasGetConnectStatus 可能不會傳回ERROR_INVALID_HANDLE。

注意

ras.h 標頭會將 RasGetSubEntryHandle 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	ras.h
程式庫	Rasapi32.lib
Dll	Rasapi32.dll