Fungsi RasGetSubEntryPropertiesA (ras.h)

Artikel
08/25/2023

Fungsi RasGetSubEntryProperties mengambil informasi tentang subentry untuk entri buku telepon tertentu.

Sintaks

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

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

Penunjuk ke string yang dihentikan null yang menentukan nama entri yang ada dalam buku telepon.

[in] unnamedParam3

Menentukan indeks subentry berbasis satu.

[in, out] unnamedParam4

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

Pada output, struktur menerima informasi tentang subentry yang ditentukan.

Pada input, anggota dwSize menentukan ukuran struktur. Ukuran mengidentifikasi versi struktur. Dapatkan ukuran ini menggunakan sizeof(RASSUBENTRY).

Parameter ini bisa NULL.

[in, out] unnamedParam5

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

Pada output, variabel menerima jumlah byte yang dikembalikan, atau jumlah byte yang diperlukan jika buffer terlalu kecil.

Parameter ini bisa NULL jika lpRasSubEntry adalah NULL.

[in] unnamedParam6

Penunjuk ke blok konfigurasi perangkat TAPI. Parameter ini saat ini tidak digunakan. Pemanggil harus meneruskan NULL untuk parameter ini. Untuk informasi selengkapnya tentang blok konfigurasi perangkat TAPI, lihat baris fungsiGetDevConfig.

[in] unnamedParam7

Penunjuk ke DWORD yang menentukan ukuran blok konfigurasi perangkat TAPI. Parameter ini saat ini tidak digunakan. Pemanggil harus meneruskan NULL untuk parameter ini.

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_BUFFER_INVALID	Alamat atau buffer yang ditentukan oleh lpRasSubEntry tidak valid.
ERROR_BUFFER_TOO_SMALL	Buffer lpRasSubEntry terlalu kecil. Variabel lpdwcb menerima ukuran buffer yang diperlukan.
ERROR_CANNOT_OPEN_PHONEBOOK	Buku telepon rusak atau komponen hilang.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Entri buku telepon tidak ada.

Keterangan

Entri buku telepon RAS dapat memiliki nol atau lebih subentri, masing-masing minimal terdiri dari perangkat dan nomor telepon. Entri buku telepon dengan beberapa subentri dapat dikonfigurasi untuk memutar nomor pertama yang tersedia atau semua subentri saat entri dipangkatkan.

Gunakan fungsi RasGetEntryProperties untuk mengambil struktur RASENTRY yang berisi informasi tentang subentri entri buku telepon. Anggota dwSubEntries menunjukkan jumlah subentri dan anggota dwDialMode menunjukkan konfigurasi panggilan.

Catatan

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