Win32 API 日本語リファレンス
ホーム › NetworkManagement.Rras › RasCustomScriptExecuteFn

RasCustomScriptExecuteFn

コールバック

シグネチャ

DWORD RasCustomScriptExecuteFn(
    HANDLE hPort,
    LPWSTR lpszPhonebook,
    LPWSTR lpszEntryName,
    PFNRASGETBUFFER pfnRasGetBuffer,
    PFNRASFREEBUFFER pfnRasFreeBuffer,
    PFNRASSENDBUFFER pfnRasSendBuffer,
    PFNRASRECEIVEBUFFER pfnRasReceiveBuffer,
    PFNRASRETRIEVEBUFFER pfnRasRetrieveBuffer,
    HWND hWnd,
    RASDIALPARAMSA* pRasDialParams,
    void* pvReserved
);

パラメーター

フィールド型説明
hPortHANDLE接続が確立されたポートへのハンドルです。ポートでデータを送受信する際は、このハンドルを使用します。
lpszPhonebookLPWSTR接続のエントリが格納されている電話帳へのパスを含む Unicode 文字列へのポインターです。
lpszEntryNameLPWSTR接続を確立するためにダイヤルされたエントリの名前を含む Unicode 文字列へのポインターです。
pfnRasGetBufferPFNRASGETBUFFER型が PFNRASGETBUFFER の関数へのポインターです。カスタムスクリプト DLL は、サーバーへデータを送信するためのメモリを割り当てる際に、この関数を使用する必要があります。
pfnRasFreeBufferPFNRASFREEBUFFER型が PFNRASFREEBUFFER の関数へのポインターです。カスタムスクリプト DLL は、 pfnRasGetBuffer 関数によって割り当てられたメモリを解放するために、この関数を使用する必要があります。
pfnRasSendBufferPFNRASSENDBUFFER型が PFNRASSENDBUFFER の関数へのポインターです。カスタムスクリプト DLL は、指定されたポートを介してサーバーと通信するために、この関数を使用します。
pfnRasReceiveBufferPFNRASRECEIVEBUFFER型が PFNRASRECEIVEBUFFER の関数へのポインターです。カスタムスクリプト DLL は、指定されたポートを介してサーバーと通信するために、この関数を使用します。
pfnRasRetrieveBufferPFNRASRETRIEVEBUFFER型が PFNRASRETRIEVEBUFFER の関数へのポインターです。カスタムスクリプト DLL は、指定されたポートを介してサーバーと通信するために、この関数を使用します。
hWndHWNDカスタムスクリプト DLL がユーザーにユーザーインターフェイスを表示するために使用できるウィンドウへのハンドルです。
pRasDialParamsRASDIALPARAMSA*Unicode 版の RASDIALPARAMS 構造体へのポインターです。この構造体には、ユーザーの認証資格情報が格納されています。カスタムスクリプト DLL は、この構造体の szUserName、szPassword、szDomain の各メンバーを変更できます。ポイントツーポイント プロトコル (PPP) は、 RasCustomScriptExecute が制御を返した時点でこれらのメンバーに格納されている値を使用します。
pvReservedvoid*

- pRasCustomScriptExtensions [in]

RASCUSTOMSCRIPTEXTENSIONS 構造体へのポインターです。この構造体には、カスタムスクリプト DLL 向けの追加関数へのポインターが格納されています。

Windows 2000: このパラメーターは Windows SP2 以降でサポートされます。

公式ドキュメント

RAS は、 RASEO_CustomScript オプションが設定された電話帳エントリの接続を確立するときに、 RasCustomScriptExecute 関数を呼び出します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS である必要があります。

関数が失敗した場合、戻り値は Winerror.h または Raserror.h に定義された適切なエラーコードである必要があります。

解説(Remarks)

RAS が RasCustomScriptExecute を呼び出すとき、pRasDialParams パラメーターは Unicode 版の RASDIALPARAMS 構造体を指します。つまり、この構造体には Unicode 文字列のみが格納されています。

場合によっては、 RASDIALPARAMS 構造体の szUserName が空の文字列になることがあります。その場合、カスタムスクリプト DLL は Unicode 版の GetUserName 関数を使用して、現在のユーザーの名前を取得する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)