RasCustomScriptExecuteFn 回呼函式 (ras.h)

發行項
03/05/2024

RAS 在建立已設定RASEO_CustomScript選項的電話簿項目連線時，RAS 會呼叫 RasCustomScriptExecute 函式。

語法

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
)
{...}

參數

[in] hPort

線上建立所在的埠句柄。在埠上傳送或接收數據時，請使用此句柄。

[in] lpszPhonebook

Unicode 字串的指標，其中包含連線專案所在的電話簿路徑。

[in] lpszEntryName

Unicode 字串的指標，其中包含已撥號以建立連接的項目名稱。

[in] pfnRasGetBuffer

PFNRASGETBUFFER 類型的函式指標。自定義文稿 DLL 應該使用此函式來配置記憶體，以將數據傳送至伺服器。

[in] pfnRasFreeBuffer

PFNRASFREEBUFFER 類型的函式指標。自定義腳本 DLL 應該使用此函式來釋放 pfnRasGetBuffer 函式所配置的記憶體。

[in] pfnRasSendBuffer

PFNRASSENDBUFFER 類型的函式指標。自定義文本 DLL 會使用此函式，透過指定的埠與伺服器通訊。

[in] pfnRasReceiveBuffer

PFNRASRECEIVEBUFFER 類型的函式指標。自定義文本 DLL 會使用此函式，透過指定的埠與伺服器通訊。

[in] pfnRasRetrieveBuffer

PFNRASRETRIEVEBUFFER 類型的函式指標。自定義文本 DLL 會使用此函式，透過指定的埠與伺服器通訊。

[in] hWnd

自定義腳本 DLL 可用來向用戶呈現使用者介面的視窗句柄。

[in] pRasDialParams

Unicode RASDIALPARAMS 結構的指標。此結構包含使用者的驗證認證。自定義腳本 DLL 可以修改此結構的 szUserName、 szPassword 和 szDomain 成員。當 RasCustomScriptExecute 傳回時，點對點通訊協定 (PPP) 將會使用這些成員中儲存的任何專案。

pvReserved

傳回值

如果函式成功，則傳回值應該 ERROR_SUCCESS。

如果函式失敗，傳回值應該是 Winerror.h 或 Raserror.h 的適當錯誤碼。

備註

當 RAS 呼叫 RasCustomScriptExecute 時， pRasDialParams 參數會指向 Unicode RASDIALPARAMS 結構。也就是說，結構只包含 Unicode 字串。

在某些情況下，RASDIALPARAMS 結構的 szUserName 會是空字串。在這些情況下，自定義腳本 DLL 應該使用 GetUserName 函式的 Unicode 版本來取得目前使用者的名稱。

規格需求

需求	值
最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	ras.h