Fungsi RasSetEntryPropertiesA (ras.h)

Artikel
08/25/2023

Fungsi RasSetEntryProperties mengubah informasi koneksi untuk entri dalam buku telepon atau membuat entri buku telepon baru.

Sintaks

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

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 .

[in] unnamedParam2

Penunjuk ke string yang dihentikan null yang menentukan nama entri.

Jika nama entri cocok dengan entri yang ada, RasSetEntryProperties memodifikasi properti entri tersebut.

Jika nama entri tidak cocok dengan entri yang ada, RasSetEntryProperties membuat entri buku telepon baru. Untuk entri baru, panggil fungsi RasValidateEntryName untuk memvalidasi nama entri sebelum memanggil RasSetEntryProperties.

[in] unnamedParam3

Penunjuk ke struktur RASENTRY yang menentukan data koneksi baru yang akan dikaitkan dengan entri buku telepon yang ditunjukkan oleh parameter lpszEntry .

Pemanggil harus menyediakan nilai untuk anggota berikut dalam struktur RASENTRY .

dwSize
szLocalPhoneNumber
szDeviceName
szDeviceType
dwFramingProtocol
dwfOptions
dwType

Windows XP atau yang lebih baru: dwType didukung.

Jika nilai tidak disediakan untuk anggota ini, RasSetEntryProperties gagal dengan ERROR_INVALID_PARAMETER.

Struktur mungkin diikuti oleh array string nomor telepon alternatif yang dihentikan null. String terakhir dihentikan oleh dua karakter null berturut-turut. Anggota dwAlternateOffset dari struktur RASENTRY berisi offset ke string pertama.

[in] unnamedParam4

Menentukan ukuran, dalam byte, dari buffer yang diidentifikasi oleh parameter lpRasEntry .

[in] unnamedParam5

Penunjuk ke buffer yang menentukan informasi konfigurasi khusus perangkat. Ini adalah informasi konfigurasi perangkat TAPI buram. Untuk informasi selengkapnya tentang konfigurasi perangkat TAPI, lihat fungsi lineGetDevConfig di Telephony Application Programming Interfaces (TAPI) di Platform SDK.

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

[in] unnamedParam6

Menentukan ukuran, dalam byte, dari buffer lpbDeviceInfo .

Windows XP: Parameter ini tidak digunakan. Fungsi panggilan harus mengatur parameter ini ke nol.

Mengembalikan nilai

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_ACCESS_DENIED	Pengguna tidak memiliki hak istimewa yang benar. Hanya administrator yang bisa menyelesaikan tugas ini.
ERROR_BUFFER_INVALID	Alamat atau buffer yang ditentukan oleh lpRasEntry tidak valid.
ERROR_CANNOT_OPEN_PHONEBOOK	Buku telepon rusak atau komponen hilang.
ERROR_INVALID_PARAMETER	Struktur RASENTRY yang diacu oleh parameter lpRasEntry tidak berisi informasi yang memadai, atau entri yang ditentukan tidak ada di buku telepon. Lihat deskripsi untuk lpRasEntry untuk melihat informasi apa yang diperlukan.

Keterangan

Saat mengatur properti untuk koneksi semua pengguna, jika aplikasi panggilan menentukan nilai non-NULL untuk parameter buku telepon, lpszPhonebook, file buku telepon harus terletak di direktori buku telepon di bawah jalur data aplikasi semua pengguna. Untuk mendapatkan lokasi yang benar untuk file buku telepon, pertama-tama panggil SHGetFolderPath dengan nilai CSIDLCSIDL_COMMON_APPDATA. SHGetFolderPath mengembalikan jalur data aplikasi semua pengguna. Tambahkan string berikut ke jalur ini:

Microsoft\Network\Connections\Pbk

Jalur gabungan adalah lokasi yang benar untuk file buku telepon.

Catatan Menentukan nilai non-NULL untuk parameter lpszPhonebook mungkin tidak didukung di versi Windows lebih lambat dari Windows XP.

Catatan

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