RasGetEntryDialParamsA 函式（ras.h）

發行項
11/20/2024

RasGetEntryDialParams 函式會擷取最後一次成功呼叫 RasDial 或 RasSetEntryDialParams 函式所儲存的連接資訊。

語法

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

參數

[in] unnamedParam1

null終止字串的指標，指定電話簿檔案的完整路徑和檔名。如果此參數 NULL，則函式會使用目前的預設電話簿檔案。默認的電話簿檔案是使用者在 [撥號網络] 對話框中 [使用者 喜好設定] 屬性表中選取的默認電話簿檔案。

Windows Me/98/95：此參數一律 NULL。撥號網路會將電話簿專案儲存在登錄中，而不是儲存在電話簿檔案中。

[in, out] unnamedParam2

RASDIALPARAMS 結構的指標。

在輸入時，dwSize 成員會指定 RASDIALPARAMS 結構的大小，而 szEntryName 成員會指定有效的電話簿專案。

在輸出中，結構會接收與指定之電話簿專案相關聯的連接參數。

請注意，szPhoneNumber 結構的成員不會收到與電話簿專案相關聯的電話號碼。若要取得與電話簿項目相關聯的電話號碼，請呼叫 RasGetEntryProperties 函式。如果 szPhoneNumber 是傳遞至 RasDial RASDIALPARAMS 結構中的空字串串，RasDial 會使用儲存在電話簿專案中的電話號碼。

szPasswordRASDIALPARAMS 結構的成員不會傳回實際的密碼。相反地，szPassword 包含已儲存密碼的句柄。在對 RasSetEntryDialParams 和 RasDial的後續呼叫中，將這個句柄取代為已儲存的密碼。當顯示此句柄時，RasDial 擷取並使用儲存的密碼。此句柄的值可能會在未來的操作系統版本中變更;請勿開發相依於此值內容或格式的程序代碼。

Windows NT 和 Windows Me/98/95：不支援 安全密碼功能。

[out] unnamedParam3

旗標的指標，指出函式是否擷取與電話簿專案之使用者名稱相關聯的密碼。如果系統已儲存指定項目的密碼，lpfPassword 參數 TRUE。如果系統沒有儲存這個項目的密碼，lpfPasswordFALSE。

Windows NT 和 Windows Me/98/95：函式會將此旗標設定 為 true，如果使用者的密碼是在 szPass word 中傳回，RASDIALPARAMS 結構所指向的 RASDIALPARAMS 結構。

傳回值

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

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

價值	描述
ERROR_BUFFER_INVALID	lprasdialparams 或 lpfPassword 指標無效，或 lprasdialparams 緩衝區無效。
ERROR_CANNOT_OPEN_PHONEBOOK	電話簿已損毀或遺失元件。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	電話簿專案不存在。

言論

注意

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

要求

要求	價值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
支援的最低伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平臺	窗戶
標頭	ras.h
連結庫	Rasapi32.lib
DLL	Rasapi32.dll