RasGetEntryDialParamsA 関数 (ras.h)

[アーティクル]
11/20/2024

RasGetEntryDialParams 関数は、最後に正常に呼び出された RasDial または指定された電話帳エントリの RasSetEntryDialParams 関数によって保存された接続情報を取得します。

構文

DWORD RasGetEntryDialParamsA(
  [in]      LPCSTR           unnamedParam1,
  [in, out] LPRASDIALPARAMSA unnamedParam2,
  [out]     LPBOOL           unnamedParam3
);

パラメーター

[in] unnamedParam1

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

Windows Me/98/95: このパラメーターは常に NULLする必要があります。ダイヤルアップネットワークでは、電話帳ファイルではなく、レジストリに電話帳エントリが格納されます。

[in, out] unnamedParam2

RASDIALPARAMS 構造体へのポインター。

入力時に、dwSize メンバーは RASDIALPARAMS 構造体のサイズを指定し、szEntryName メンバーは有効な電話帳エントリを指定します。

出力時に、構造体は、指定された電話帳エントリに関連付けられている接続パラメーターを受け取ります。

構造体の szPhoneNumber メンバーは、電話帳エントリに関連付けられている電話番号を受信しないことに注意してください。電話帳のエントリに関連付けられている電話番号を取得するには、RasGetEntryProperties 関数を呼び出します。 SzPhoneNumber が、RasDialに渡される RASDIALPARAMS 構造体の空の文字列である場合、RasDial は電話帳エントリに格納されている電話番号を使用。

RASDIALPARAMS 構造体の szPassword メンバーは、実際のパスワードを返しません。代わりに、szPassword には、保存されたパスワードへのハンドルが含まれています。このハンドルは、RasSetEntryDialParams および RasDial後続の呼び出しで保存されたパスワードに置き換えられます。このハンドルが表示されると、RasDial 保存されたパスワードを取得して使用します。このハンドルの値は、オペレーティングシステムの将来のバージョンで変更される可能性があります。この値の内容または形式に依存するコードを開発しないでください。

Windows NT および Windows Me/98/95: セキュリティで保護されたパスワード機能はサポートされていません。

[out] unnamedParam3

関数が電話帳エントリのユーザー名に関連付けられているパスワードを取得したかどうかを示すフラグへのポインター。 lpfPassword パラメーターは、システムが指定したエントリのパスワードを保存している場合に TRUE 。システムにこのエントリのパスワードが保存されていない場合、lpfPassword は FALSE。

Windows NT および Windows Me/98/95: この関数は、ユーザーのパスワードが lprasdialparams によって指される RASDIALPARAMS 構造体の szPassword メンバーで返された場合に、このフラグを TRUE 設定します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing と Remote Access Error Codes または Winerror.h からの値です。

価値	形容
ERROR_BUFFER_INVALID	lprasdialparams または lpfPassword ポインターが無効であるか、バッファー lprasdialparams が無効です。
ERROR_CANNOT_OPEN_PHONEBOOK	電話帳が破損しているか、コンポーネントが不足しています。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	電話帳のエントリが存在しません。

備考

手記

ras.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RasGetEntryDialParams を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	ras.h
ライブラリ	Rasapi32.lib
DLL	Rasapi32.dll

次の方法で共有

RasGetEntryDialParamsA 関数 (ras.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース