RasGetEntryDialParamsA 函式 (ras.h)

發行項
08/25/2023

RasGetEntryDialParams函式會針對指定的電話簿專案，擷取上次成功呼叫RasDial或RasSetEntryDialParams函式所儲存的連接資訊。

語法

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

參數

[in] unnamedParam1

Null終止字串的指標，指定電話簿 (PBK) 檔案的完整路徑和檔案名。如果此參數為 Null，函式會使用目前的預設電話簿檔案。預設電話簿檔案是由 [撥號網路] 對話方塊的 [ 使用者喜好設定 ] 屬性工作表中的使用者所選取的檔案。

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

[in, out] unnamedParam2

RASDIALPARAMS結構的指標。

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

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

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

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

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

[out] unnamedParam3

旗標的指標，指出函式是否擷取與電話簿專案使用者名稱相關聯的密碼。如果系統已為指定的專案儲存密碼， 則 lpfPassword 參數為 TRUE 。如果系統未儲存此專案的密碼， lpfPassword 為 FALSE。

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

傳回值

如果函式成功，傳回值 會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 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	ras.h
程式庫	Rasapi32.lib
Dll	Rasapi32.dll