RasCustomDialFn
コールバックシグネチャ
DWORD RasCustomDialFn(
HINSTANCE hInstDll,
RASDIALEXTENSIONS* lpRasDialExtensions,
LPWSTR lpszPhonebook,
RASDIALPARAMSA* lpRasDialParams,
DWORD dwNotifierType,
void* lpvNotifier,
HRASCONN* lphRasConn,
DWORD dwFlags
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| hInstDll | HINSTANCE | 読み込まれたカスタムダイヤル DLL のインスタンスへのハンドル。 |
| lpRasDialExtensions | RASDIALEXTENSIONS* | RASDIALEXTENSIONS 構造体へのポインター。この構造体は、有効にする RasDial の拡張機能のセットを指定します。拡張機能を有効にする必要がない場合は、このパラメーターを NULL に設定します。 |
| lpszPhonebook | LPWSTR | 電話帳 (PBK) ファイルの完全パスとファイル名を指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。既定の電話帳ファイルは、ダイヤルアップ ネットワーク ダイアログボックスの ユーザー設定 プロパティシートでユーザーが選択したファイルです。 |
| lpRasDialParams | RASDIALPARAMSA* | RASDIALPARAMS 構造体へのポインター。この構造体は、RAS 接続の呼び出しパラメーターを指定します。 呼び出し元は、渡す構造体のバージョンを示すために、 RASDIALPARAMS 構造体の dwSize メンバーに sizeof(RASDIALPARAMS) を設定する必要があります。 |
| dwNotifierType | DWORD | このパラメーターは、 RasDial 関数の dwNotifierType パラメーターと同じです。詳細については、 RasDial のリファレンスページを参照してください。 |
| lpvNotifier | void* | このパラメーターは、 RasDial 関数の lpvNotifier パラメーターと同じです。詳細については、 RasDial のリファレンスページを参照してください。 |
| lphRasConn | HRASCONN* | HRASCONN 型の変数へのポインター。 RasDial を呼び出す前に、HRASCONN 変数を NULL に設定してください。 RasDial が成功すると、RAS 接続へのハンドルが *lphRasConn に格納されます。 |
| dwFlags | DWORD | このパラメーターは将来使用するために予約されています。 |
公式ドキュメント
[この関数は Windows Server 2008 以降では使用できません。
]
RasCustomDial 関数は、サードパーティ製のカスタムダイヤル DLL によってエクスポートされるアプリケーション定義の関数です。この関数により、サードパーティのベンダーは独自のリモートアクセスダイヤルルーチンを実装できます。
戻り値
関数が成功すると、戻り値は ERROR_SUCCESS となり、lphRasConn パラメーターが指す変数に RAS 接続へのハンドルが返されます。
関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing and Remote Access Error Codes や Winerror.h に定義された値です。
| 値 | 意味 |
|---|---|
| 関数は、処理を完了するのに十分なメモリを割り当てられませんでした。 |
解説(Remarks)
ダイヤルするエントリの RASENTRY 構造体の szCustomDialDll メンバーがカスタムダイヤル DLL を指定している場合、RAS は RasDial からこのエントリポイントを呼び出します。
このエントリポイントが RasDial を呼び出す場合、lpRasDialExtensions パラメーターを NULL にすることはできず、 RASDIALEXTENSIONS 構造体の dwFlags メンバーに RDEOPT_CustomDial フラグを設定する必要があります。
カスタムダイヤル DLL がこのエントリポイントをサポートしていない場合、RAS は RasDial の呼び出し元に ERROR_CANNOT_DO_CUSTOMDIAL を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)