Fungsi RasGetEapUserIdentityA (ras.h)

Artikel
03/15/2023

Fungsi RasGetEapUserIdentity mengambil informasi identitas untuk pengguna saat ini. Gunakan informasi ini untuk memanggil RasDial dengan entri buku telepon yang memerlukan Extensible Authentication Protocol (EAP).

Sintaks

DWORD RasGetEapUserIdentityA(
  [in]  LPCSTR                pszPhonebook,
  [in]  LPCSTR                pszEntry,
  [in]  DWORD                 dwFlags,
  [in]  HWND                  hwnd,
  [out] LPRASEAPUSERIDENTITYA *ppRasEapUserIdentity
);

Parameter

[in] pszPhonebook

Penunjuk ke string yang dihentikan null yang menentukan jalur lengkap file buku telepon (PBK). Jika parameter ini NULL, fungsi menggunakan buku telepon sistem.

[in] pszEntry

Penunjuk ke string yang dihentikan null yang menentukan nama entri yang ada.

[in] dwFlags

Menentukan nol atau lebih dari bendera berikut yang memenuhi syarat proses autentikasi.

Bendera	Makna
RASEAPF_NonInteractive	Menentukan bahwa protokol autentikasi tidak boleh memunculkan antarmuka pengguna grafis. Jika bendera ini tidak ada, protokol tidak apa-apa untuk menampilkan antarmuka pengguna.
RASEAPF_Logon	Menentukan bahwa data pengguna diperoleh dari WinLogon.
RASEAPF_Preview	Menentukan bahwa pengguna harus dimintai informasi identitas sebelum memutar nomor.

[in] hwnd

Tangani ke jendela induk untuk dialog UI. Jika parameter fInvokeUIFALSE, maka hwnd harus NULL.

[out] ppRasEapUserIdentity

Penunjuk ke pointer yang, saat berhasil dikembalikan, menerima alamat struktur RASEAPUSERIDENTITY yang berisi informasi identitas pengguna EAP. RasGetEapUserIdentity mengalokasikan buffer memori untuk struktur RASEAPUSERIDENTITY . Bebaskan memori ini dengan memanggil RasFreeEapUserIdentity.

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
E_INVALID_ARG	Parameter pcbEapUserIdentity adalah NULL.
ERROR_INTERACTIVE_MODE	Fungsi ini dipanggil dengan bendera RASEAPF_NonInteractive. Namun, protokol autentikasi harus menampilkan UI untuk mendapatkan informasi identitas yang diperlukan dari pengguna.
ERROR_INVALID_FUNCTION_FOR_ENTRY	Baik metode autentikasi untuk entri buku telepon ini bukan EAP, atau metode autentikasi adalah EAP tetapi protokol menggunakan dialog kredensial Windows NT/Windows 2000 standar untuk mendapatkan informasi identitas pengguna. Dalam kedua kasus, penelepon tidak perlu meneruskan informasi identitas EAP ke RasDial.
ERROR_RASMAN_CANNOT_INITIALIZE	Layanan Akses Jarak Jauh gagal diinisialisasi dengan benar.
Lainnya	Gunakan FormatMessage untuk mengambil pesan kesalahan sistem yang sesuai dengan kode kesalahan yang dikembalikan.

Keterangan

RasGetEapUserIdentity memanggil fungsi RAS RasGetEapUserData dan fungsi EAP RasEapGetIdentity. RasEapGetIdentity diimplementasikan oleh protokol autentikasi.

Jika fungsi berhasil, yaitu nilai yang dikembalikan NO_ERROR, pemanggil harus menyalin informasi identitas EAP dari struktur RASEAPUSERIDENTITY yang ditunjukkan oleh parameter ppRasEapUserIdentity ke struktur RASDIALPARAMS dan RASDIALEXTENSIONS yang digunakan dalam panggilan ke RasDial.

Jika aplikasi akses jarak jauh yang dikembangkan memiliki antarmuka pengguna grafis, pemanggil RasGetEapUserIdentity tidak boleh menentukan bendera RASEAPF_NonInteractive. Jika aplikasi memiliki antarmuka pengguna baris perintah, pemanggil mungkin ingin menentukan bendera RASEAPF_NonInteractive untuk mencegah protokol autentikasi menampilkan antarmuka pengguna grafis.

Catatan

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