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

  • [アーティクル]

[この関数は、Windows Server 2008 の時点では使用できません。

]

RasCustomDial 関数は、サードパーティのカスタム ダイヤル DLL によってエクスポートされるアプリケーション定義関数です。 この機能を使用すると、サードパーティベンダーはカスタム リモート アクセス ダイヤル ルーチンを実装できます。

構文

RasCustomDialFn Rascustomdialfn;

DWORD Rascustomdialfn(
  HINSTANCE hInstDll,
  LPRASDIALEXTENSIONS lpRasDialExtensions,
  LPCWSTR lpszPhonebook,
  LPRASDIALPARAMS lpRasDialParams,
  DWORD dwNotifierType,
  LPVOID lpvNotifier,
  LPHRASCONN lphRasConn,
  DWORD dwFlags
)
{...}

パラメーター

hInstDll

読み込まれたカスタム ダイヤル DLL のインスタンスを処理します。

lpRasDialExtensions

有効にする RasDial 拡張機能のセットを指定する RASDIALEXTENSIONS 構造体へのポインター。 拡張機能を有効にする必要がない場合は、このパラメーターを NULL に設定します。

lpszPhonebook

電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。 既定の電話帳ファイルは、[ダイヤルアップ ネットワーク] ダイアログ ボックスの [ユーザー設定] プロパティ シートでユーザーが選択したファイルです。

lpRasDialParams

RAS 接続の呼び出しパラメーターを指定する RASDIALPARAMS 構造体へのポインター。

呼び出し元は、渡される構造体のバージョンを識別するために、 RASDIALPARAMS 構造体の dwSize メンバーを sizeof(RASDIALPARAMS) に設定する必要があります。

dwNotifierType

このパラメーターは、RasDial 関数の dwNotifierType パラメーターと同じです。 詳細については、 RasDial リファレンス ページを参照してください。

lpvNotifier

このパラメーターは、RasDial 関数の lpvNotifier パラメーターと同じです。 詳細については、 RasDial リファレンス ページを参照してください。

lphRasConn

HRASCONN 型の変数へのポインター。 RasDial を呼び出す前に、HRASCONN 変数を NULL に設定します。 RasDial が成功すると、RAS 接続へのハンドルが *lphRasConn に格納されます。

dwFlags

このパラメーターは、今後使用するために予約されています。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS され、 lphRasConn パラメーターによって指される変数内の RAS 接続へのハンドルが返されます。

関数が失敗した場合、戻り値は次のいずれかのエラー コードか、 ルーティングおよびリモート アクセス エラー コード または Winerror.h からの値です。

値 説明
ERROR_NOT_ENOUGH_MEMORY
 関数は、操作を完了するのに十分なメモリを割り当てませんでした。

解説

RAS は、ダイヤルされるエントリの RASENTRY 構造体の szCustomDialDll メンバーがカスタム ダイヤル DLL を指定している場合、RasDial からこのエントリ ポイントを呼び出します。

このエントリ ポイントが RasDial を呼び出す場合、lpRasDialExtensions パラメーターを NULL にすることはできません。また、RASDIALEXTENSIONS 構造体の dwFlags メンバーには、RDEOPT_CustomDial フラグが設定されている必要があります。

カスタム ダイヤル DLL がこのエントリ ポイントをサポートしていない場合、RAS は RasDial の呼び出し元にERROR_CANNOT_DO_CUSTOMDIALを返します。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ras.h

関連項目

カスタム ダイヤラー

RASENTRY

RasCustomDialDlg

RasCustomEntryDlg

RasCustomHangUp

Rasdial

リモート アクセス サービス (RAS) の概要

リモート アクセス サービス関数