Fungsi RasGetEntryDialParamsA (ras.h)

Artikel
08/25/2023

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

Sintaks

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           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, out] unnamedParam2

Penunjuk ke struktur RASDIALPARAMS .

Pada input, anggota dwSize menentukan ukuran struktur RASDIALPARAMS , dan anggota szEntryName menentukan entri buku telepon yang valid.

Pada output, struktur menerima parameter koneksi yang terkait dengan entri buku telepon yang ditentukan.

Perhatikan bahwa anggota struktur szPhoneNumber tidak menerima nomor telepon yang terkait dengan entri buku telepon. Untuk mendapatkan nomor telepon yang terkait dengan entri buku telepon, panggil fungsi RasGetEntryProperties . Jika szPhoneNumber adalah string kosong dalam struktur RASDIALPARAMS yang diteruskan ke RasDial, RasDial menggunakan nomor telepon yang disimpan dalam entri buku telepon.

Anggota szPassword dari struktur RASDIALPARAMS tidak mengembalikan kata sandi yang sebenarnya. Sebagai gantinya, szPassword berisi handel ke kata sandi yang disimpan. Ganti handel ini untuk kata sandi yang disimpan dalam panggilan berikutnya ke RasSetEntryDialParams dan RasDial. Ketika disajikan dengan handel ini, RasDial mengambil dan menggunakan kata sandi yang disimpan. Nilai handel ini dapat berubah dalam versi sistem operasi yang akan datang; jangan kembangkan kode yang bergantung pada konten atau format nilai ini.

Windows NT dan Windows Me/98/95: Fitur kata sandi aman tidak didukung.

[out] unnamedParam3

Penunjuk ke bendera yang menunjukkan apakah fungsi mengambil kata sandi yang terkait dengan nama pengguna untuk entri buku telepon. Parameter lpfPasswordTRUE jika sistem telah menyimpan kata sandi untuk entri yang ditentukan. Jika sistem tidak memiliki kata sandi yang disimpan untuk entri ini, lpfPassword adalah FALSE.

Windows NT dan Windows Me/98/95: Fungsi mengatur bendera ini ke TRUE jika kata sandi pengguna dikembalikan di anggota szPassword dari struktur RASDIALPARAMS yang diarahkan oleh lprasdialparams.

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	Penunjuk lprasdialparams atau lpfPassword tidak valid, atau buffer lprasdialparams tidak valid.
ERROR_CANNOT_OPEN_PHONEBOOK	Buku telepon rusak atau komponen hilang.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Entri buku telepon tidak ada.

Keterangan

Catatan

Header ras.h mendefinisikan RasGetEntryDialParams 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


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