Fungsi RasGetEntryPropertiesA (ras.h)

Fungsi RasGetEntryProperties mengambil properti entri buku telepon.

Sintaks

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

Parameter

[in] unnamedParam1

Penunjuk ke string yang dihentikan null yang menentukan jalur lengkap dan nama file file buku telepon (PBK). Jika parameter ini 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 dalam registri, bukan dalam file buku telepon.

[in] unnamedParam2

Penunjuk ke string yang dihentikan null yang menentukan nama entri yang ada. Jika string kosong ditentukan, fungsi mengembalikan nilai default dalam buffer yang diacu oleh parameter lpRasEntry dan lpbDeviceInfo .

[in, out] unnamedParam3

Penunjuk ke struktur RASENTRY diikuti dengan byte tambahan untuk daftar nomor telepon alternatif, jika ada.

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

Pada input, atur anggota dwSize struktur ke sizeof (RASENTRY) untuk mengidentifikasi versi struktur.

Parameter ini bisa NULL.

Windows Me/98 dan Windows 95 OSR2: Lapisan Microsoft untuk Unicode tidak mendukung dwAlternateOffset di RASENTRY.

[in, out] unnamedParam4

Penunjuk ke variabel yang, pada input, menentukan ukuran, dalam byte, dari buffer lpRasEntry .

Pada output, variabel ini menerima jumlah byte yang diperlukan.

Parameter ini dapat berupa NULL jika parameter lpRasEntry adalah NULL.

Untuk menentukan ukuran buffer yang diperlukan, panggil RasGetEntryProperties dengan lpRasEntry diatur ke NULL dan *lpdwEntryInfoSize diatur ke nol. Fungsi mengembalikan ukuran buffer yang diperlukan dalam *lpdwEntryInfoSize.

[out] unnamedParam5

Parameter ini tidak lagi digunakan. Fungsi panggilan harus mengatur parameter ini ke NULL.

Windows Me/98/95: Penunjuk ke buffer yang menerima informasi konfigurasi khusus perangkat. Jangan langsung memanipulasi informasi perangkat TAPI buram ini. Untuk informasi selengkapnya tentang konfigurasi perangkat TAPI, lihat fungsi lineGetDevConfig di Referensi Programmer TAPI di Platform SDK.

Parameter ini bisa NULL.

[in, out] unnamedParam6

Parameter ini tidak digunakan. Fungsi panggilan harus mengatur parameter ini ke NULL.

Windows Me/98/95: Penunjuk ke variabel yang, pada input, menentukan ukuran, dalam byte, dari buffer yang ditentukan oleh parameter lpbDeviceInfo .

Pada output, variabel ini menerima jumlah byte yang diperlukan.

Parameter ini bisa NULL jika parameter lpbDeviceInfo s NULL.

Untuk menentukan ukuran buffer yang diperlukan, panggil RasGetEntryProperties dengan lpbDeviceInfo diatur ke NULL dan *lpdwDeviceInfoSize diatur ke nol. Fungsi mengembalikan ukuran buffer yang diperlukan dalam *lpdwDeviceInfoSize.

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	Makna
ERROR_INVALID_PARAMETER	Fungsi ini dipanggil dengan parameter yang tidak valid.
ERROR_INVALID_SIZE	Nilai anggota dwSize dari lpRasEntry terlalu kecil.
ERROR_BUFFER_INVALID	Alamat atau buffer yang ditentukan oleh lpRasEntry tidak valid.
ERROR_BUFFER_TOO_SMALL	Ukuran buffer yang ditunjukkan dalam lpdwEntryInfoSize terlalu kecil.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Entri buku telepon tidak ada, atau file buku telepon rusak dan/atau memiliki komponen yang hilang.

Keterangan

Catatan

Header ras.h mendefinisikan RasGetEntryProperties sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praproscesor 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

Lihat juga

RASENTRY

RasSetEntryProperties

Gambaran Umum Layanan Akses Jarak Jauh (RAS)

Fungsi Layanan Akses Jarak Jauh