RASADFUNCA
コールバックシグネチャ
BOOL RASADFUNCA(
LPSTR param0,
LPSTR param1,
RASADPARAMS* param2,
DWORD* param3
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| param0 | LPSTR | |
| param1 | LPSTR | |
| 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 オートダイヤルハンドラーを有効にするには、 RasSetEntryProperties 関数の呼び出しで RASENTRY 構造体を使用します。szAutodialDll メンバーはハンドラーを含む DLL の名前を指定し、szAutodialFunc メンバーはハンドラーのエクスポート名を指定します。szAutodialFunc メンバーには "A" または "W" のサフィックスを含めないでください。
RASADFunc は、ライブラリ側で定義する関数名のプレースホルダーです。RASADFUNC 型は、 RASADFunc 関数へのポインターです。
ras.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、RASADFUNC を定義します。エンコードに依存しないエイリアスと、エンコードに依存するコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)