Fungsi RasSetEntryDialParamsA (ras.h)

Artikel
08/25/2023

Fungsi RasSetEntryDialParams mengubah informasi koneksi yang disimpan oleh panggilan terakhir yang berhasil ke fungsi RasDial atau RasSetEntryDialParams untuk entri buku telepon tertentu.

Sintaks

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

Parameter

[in] unnamedParam1

Penunjuk ke string yang dihentikan null yang menentukan jalur lengkap dan nama file dari file buku telepon (PBK). Jika parameter ini ADALAH NULL, fungsi menggunakan file buku telepon default saat ini. File buku telepon default adalah file yang dipilih oleh pengguna di lembar properti Preferensi Pengguna dari kotak dialog Jaringan Dial-Up .

Windows Me/98/95: Parameter ini harus selalu NULL. Jaringan dial-up menyimpan entri buku telepon di registri daripada dalam file buku telepon.

[in] unnamedParam2

Arahkan ke struktur RASDIALPARAMS yang menentukan parameter koneksi yang akan dikaitkan dengan entri buku telepon. RasSetEntryDialParams menggunakan anggota struktur sebagai berikut.

Anggota	Makna
dwSize	Harus menentukan ukuran (RASDIALPARAMS) untuk mengidentifikasi versi struktur.
szEntryName	String null-terminated yang mengidentifikasi entri buku telepon untuk mengatur parameter.
szPhoneNumber	Tidak digunakan. Atur ke NULL.
szCallbackNumber	String yang dihentikan null yang berisi nomor telepon panggilan balik. Jika szCallbackNumber adalah string kosong ( "" ), nomor panggilan balik tidak diubah.
szUserName	String null-terminated yang berisi nama masuk pengguna yang terkait dengan entri ini. Jika szUserName adalah string kosong, nama pengguna tidak diubah.
szPassword	String null-terminated yang berisi kata sandi untuk pengguna yang ditentukan oleh szUserName. Jika szUserName adalah string kosong, kata sandi tidak diubah. Jika szPassword adalah string kosong dan fRemovePassword adalah FALSE, kata sandi diatur ke string kosong. Jika fRemovePasswordTRUE, kata sandi yang disimpan dalam entri buku telepon ini untuk pengguna yang ditentukan oleh szUserName dihapus terlepas dari konten string szPassword . Windows NT 4.0: Kata sandi diubah ke string yang ditentukan oleh szPassword terlepas dari apakah szUserName adalah string kosong. Windows XP/2000: Jika szPassword berisi handel kata sandi yang dikembalikan oleh RasGetCredentials atau RasGetEntryDialParams, RasSetEntryDialParams berhasil dikembalikan tanpa mengubah kata sandi yang saat ini disimpan.
szDomain	String yang dihentikan null yang berisi nama domain tempat masuk. Jika szDomain adalah string kosong, nama domain tidak diubah.
dwSubEntry	Menentukan indeks (berbasis satu) dari subentri awal untuk dial saat membuat koneksi.
dwCallbackId	Menentukan nilai yang ditentukan aplikasi yang diteruskan RAS ke fungsi panggilan balik RasDialFunc2 .

[in] unnamedParam3

Menentukan apakah akan menghapus kata sandi tersimpan entri buku telepon untuk pengguna yang ditunjukkan oleh lprasdialparams-szUserName>. Jika fRemovePasswordTRUE, kata sandi akan dihapus. Mengatur fRemovePassword ke TRUE setara dengan mencentang kotak centang "Batalkan Kata Sandi" di Jaringan Dial-Up. Saat mengatur kata sandi atau properti lain dari entri buku telepon, atur fRemovePassword ke FALSE.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah ERROR_SUCCESS.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut atau nilai dari Kode Kesalahan Perutean dan Akses Jarak Jauh atau Winerror.h.

Nilai	Deskripsi
ERROR_BUFFER_INVALID	Alamat atau buffer yang ditentukan oleh lprasdialparams tidak valid.
ERROR_CANNOT_OPEN_PHONEBOOK	Buku telepon rusak atau komponen hilang.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Entri buku telepon tidak ada.

Keterangan

Untuk membuat entri buku telepon baru, gunakan fungsi RasSetEntryProperties .

Windows XP atau yang lebih baru: Jangan gunakan fungsi RasSetEntryDialParams . Untuk mengatur kredensial untuk entri buku telepon, gunakan fungsi RasSetCredentials . Atur anggota non-kredensial RASDIALPARAMS (misalnya szCallbackNumber, dwSubEntry, atau dwCallbackId) langsung dalam struktur RASDIALPARAMS yang diteruskan sebagai parameter ke fungsi RasDial .

Catatan

Header ras.h mendefinisikan RasSetEntryDialParams sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	ras.h
Pustaka	Rasapi32.lib
DLL	Rasapi32.dll