RASADFUNCW
コールバックシグネチャ
BOOL RASADFUNCW(
LPWSTR param0,
LPWSTR param1,
RASADPARAMS* param2,
DWORD* param3
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| param0 | LPWSTR | |
| param1 | LPWSTR | |
| param2 | RASADPARAMS* | |
| param3 | DWORD* | - lpAutoDialParams [in]自動ダイヤルのユーザーインターフェイスのウィンドウをどのように配置するかを示す RASADPARAMS 構造体へのポインターです。この構造体では、自動ダイヤルウィンドウの親ウィンドウを指定することもできます。 - lpdwRetCode [out]関数がダイヤル操作を実行した場合に値を受け取る変数へのポインターです。ダイヤル操作が成功した場合は、この変数に ERROR_SUCCESS を設定します。ダイヤル操作が失敗した場合は、0 以外の値を設定します。 - lpszEntry [in]使用する電話帳エントリを指定する null 終端文字列へのポインターです。 - lpszPhonebook [in]電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null 終端文字列へのポインターです。このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。既定の電話帳ファイルは、ダイヤルアップ ネットワーク ダイアログボックスの ユーザー設定 プロパティシートでユーザーが選択したファイルです。 Windows Me/98/95: このパラメーターは常に NULL です。ダイヤルアップ ネットワークは、電話帳エントリを電話帳ファイルではなくレジストリに格納します。 |
公式ドキュメント
RASADFunc 関数は、自動ダイヤル用のカスタマイズされたユーザーインターフェイスを提供するために使用される、アプリケーション定義のコールバック関数です。
戻り値
アプリケーションがダイヤル操作を実行する場合は TRUE を返します。ダイヤル操作の結果は lpdwRetCode パラメーターで示します。
アプリケーションがダイヤル操作を実行しない場合は FALSE を返します。この場合、システムはダイヤルに既定のユーザーインターフェイスを使用します。
解説(Remarks)
システムは、カスタム自動ダイヤルハンドラーが設定された電話帳エントリに対して自動ダイヤル操作を開始するときに、指定された RASADFunc を呼び出します。 RASADFunc は、カスタムダイヤル操作を実行するスレッドを開始できます。 RASADFunc 関数は、ダイヤル処理を引き継いだことを示す場合は TRUE を、システムにダイヤル処理を行わせる場合は FALSE を返します。
RASADFunc 関数がダイヤル操作を実行する場合は、独自のダイヤル用ユーザーインターフェイスを表示し、実際のダイヤルを行うために RasDial 関数を呼び出します。その後、 RASADFunc はダイヤル処理を引き継いだことを示すために TRUE を返します。ダイヤル操作が完了したら、lpdwRetCode パラメーターが指す変数に成功または失敗を示す値を設定します。
自動ダイヤル DLL は、 RASADFunc ハンドラーの RASADFUNCA (ANSI) 版と RASADFUNCW (Unicode) 版の両方を提供する必要があります。電話帳エントリに対して RASADFunc 自動ダイヤルハンドラーを有効にするには、 RASENTRY 構造体を RasSetEntryProperties 関数の呼び出しで使用します。szAutodialDll メンバーはハンドラーを含む DLL の名前を指定し、szAutodialFunc メンバーはハンドラーのエクスポート名を指定します。szAutodialFunc メンバーには "A" または "W" のサフィックスを含めないでください。
RASADFunc は、ライブラリで定義される関数名のプレースホルダーです。RASADFUNC 型は RASADFunc 関数へのポインターです。
ras.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして、RASADFUNC を定義します。エンコードに依存しないエイリアスを、エンコードに依存するコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)