RasGetEntryDialParamsA 関数 (ras.h)

  • [アーティクル]

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

構文

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

パラメーター

[in] unnamedParam1

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

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。

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

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

解説

注意

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

要件

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

関連項目

RASDIALPARAMS

RasCreatePhonebookEntry

Rasdial

RasEditPhonebookEntry

RasSetEntryDialParams

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

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