RasSetEntryDialParamsA 函式（ras.h）

發行項
11/20/2024

RasSetEntryDialParams 函式會變更指定電話簿專案上一次成功呼叫 RasDial 或 RasSetEntryDialParams 函式所儲存的連接資訊。

語法

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

參數

[in] unnamedParam1

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

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

[in] unnamedParam2

RASDIALPARAMS 結構的指標，指定要與電話簿專案相關聯的連接參數。 RasSetEntryDialParams 會使用結構的成員，如下所示。

成員	意義
dwSize	必須指定的大小（RASDIALPARAMS），才能識別結構的版本。
szEntryName	以 Null 結尾的字串，可識別要為其設定參數的電話簿專案。
szPhoneNumber	未使用。設定為 NULL。
szCallbackNumber	包含回呼電話號碼的 Null 終止字串。如果 s szCallbackNumber 是空字串串（“”），則回呼號碼不會變更。
szUserName	以 Null 結尾的字串，其中包含與這個專案相關聯之使用者的登入名稱。如果 s szUserName 是空字串，則不會變更用戶名稱。
szPassword	以 Null 結尾的字串，其中包含 s szUserName所指定使用者的密碼。如果 szUserName 為空字串，則密碼不會變更。如果 szPassword 為空字串，且 fRemovePassword FALSE，則密碼會設定為空字串。如果 fRemovePassword TRUE，則不論 szPassword 字串串的內容為何，szUserName 所指定使用者所指定之使用者，都會移除儲存在此電話簿專案中的密碼。 Windows NT 4.0：不論 szUserName 是否為空字串串，szPass word 所指定的字元串都會變更密碼。 Windows XP/2000：如果 szPassword 包含 RasGetCredentials 或 RasGetEntryDialParams傳回的密碼句柄，RasSetEntryDialParams 會順利傳回，而不會變更任何目前儲存的密碼。
szDomain	以 Null 結尾的字串，其中包含要登入的功能變數名稱。如果 szDomain 是空字串，則功能變數名稱不會變更。
dwSubEntry	指定建立連接時所要撥號之初始子輸入的（單一型）索引。
dwCallbackId	指定 RAS 傳遞至 RasDialFunc2 回呼函式的應用程式定義值。

[in] unnamedParam3

指定是否要移除 lprasdialparams->szUserName所指示使用者的電話簿專案預存密碼。如果 fRemovePassword TRUE，則會移除密碼。將 fRemovePassword 設定為 TRUE 相當於在 Dial-Up Networking 中核取 [未儲存密碼] 複選框。設定電話簿項目的密碼或其他屬性時，請將 fRemovePassword 設定為 FALSE。

傳回值

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

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

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

言論

若要建立新的電話簿專案，請使用 RasSetEntryProperties 函式。

Windows XP 或更新版本：請勿使用 RasSetEntryDialParams 函式。若要設定電話簿項目的認證，請使用 RasSetCredentials 函式。將 RASDIALPARAMS 的非認證成員（例如，szCallbackNumber、dwSubEntry或 dwCallbackId）直接在 RASDIALPARAMS 結構中直接傳遞至 RasDial 函式。

注意

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

要求

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