RasCustomScriptExecuteFn コールバック関数 (ras.h)

[アーティクル]
03/05/2024

RAS は、RASEO_CustomScript オプションが設定されている電話帳エントリの接続を確立するときに 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 メンバーを変更できます。ポイントツーポイントプロトコル (PPP) は、 RasCustomScriptExecute が返されるときに、これらのメンバーに格納されているものを使用します。

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