Fungsi panggilan balik RasCustomScriptExecuteFn (ras.h)

Artikel
03/04/2024

RAS memanggil fungsi RasCustomScriptExecute saat membuat koneksi untuk entri buku telepon yang memiliki opsi RASEO_CustomScript diatur.

Sintaks

RasCustomScriptExecuteFn Rascustomscriptexecutefn;

DWORD Rascustomscriptexecutefn(
  [in] HANDLE hPort,
  [in] LPCWSTR lpszPhonebook,
  [in] LPCWSTR lpszEntryName,
  [in] PFNRASGETBUFFER pfnRasGetBuffer,
  [in] PFNRASFREEBUFFER pfnRasFreeBuffer,
  [in] PFNRASSENDBUFFER pfnRasSendBuffer,
  [in] PFNRASRECEIVEBUFFER pfnRasReceiveBuffer,
  [in] PFNRASRETRIEVEBUFFER pfnRasRetrieveBuffer,
  [in] HWND hWnd,
  [in] RASDIALPARAMS *pRasDialParams,
       PVOID pvReserved
)
{...}

Parameter

[in] hPort

Tangani ke port tempat koneksi dibuat. Gunakan handel ini saat mengirim atau menerima data pada port.

[in] lpszPhonebook

Penunjuk ke string Unicode yang berisi jalur ke buku telepon tempat entri untuk koneksi berada.

[in] lpszEntryName

Penunjuk ke string Unicode yang berisi nama entri yang dihubungi untuk membuat koneksi.

[in] pfnRasGetBuffer

Penunjuk ke fungsi jenis PFNRASGETBUFFER. DLL skrip kustom harus menggunakan fungsi ini untuk mengalokasikan memori untuk mengirim data ke server.

[in] pfnRasFreeBuffer

Penunjuk ke fungsi jenis PFNRASFREEBUFFER. DLL skrip kustom harus menggunakan fungsi ini untuk membebaskan memori yang dialokasikan oleh fungsi pfnRasGetBuffer .

[in] pfnRasSendBuffer

Penunjuk ke fungsi jenis PFNRASSENDBUFFER. DLL skrip kustom menggunakan fungsi ini untuk berkomunikasi dengan server melalui port yang ditentukan.

[in] pfnRasReceiveBuffer

Penunjuk ke fungsi jenis PFNRASRECEIVEBUFFER. DLL skrip kustom menggunakan fungsi ini untuk berkomunikasi dengan server melalui port yang ditentukan.

[in] pfnRasRetrieveBuffer

Penunjuk ke fungsi jenis PFNRASRETRIEVEBUFFER. DLL skrip kustom menggunakan fungsi ini untuk berkomunikasi dengan server melalui port yang ditentukan.

[in] hWnd

Tangani ke jendela yang dapat digunakan DLL skrip kustom untuk menyajikan antarmuka pengguna kepada pengguna.

[in] pRasDialParams

Penunjuk ke struktur RASDIALPARAMS Unicode. Struktur ini berisi kredensial autentikasi untuk pengguna. DLL skrip kustom dapat memodifikasi anggota szUserName, szPassword, dan szDomain dari struktur ini. Point-to-Point Protocol (PPP) akan menggunakan apa pun yang disimpan dalam anggota ini saat RasCustomScriptExecute kembali.

pvReserved

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan harus ERROR_SUCCESS.

Jika fungsi gagal, nilai pengembalian harus menjadi kode kesalahan yang sesuai dari Winerror.h atau Raserror.h.

Keterangan

Ketika RAS memanggil RasCustomScriptExecute, parameter pRasDialParams akan menunjuk ke struktur RASDIALPARAMS Unicode. Artinya, struktur hanya berisi string Unicode.

Dalam beberapa kasus, szUserName dari struktur RASDIALPARAMS akan menjadi string kosong. Dalam kasus ini, DLL skrip kustom harus menggunakan versi Unicode dari fungsi GetUserName untuk mendapatkan nama pengguna saat ini.

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