RasSetEntryDialParamsA 関数 (ras.h)

[アーティクル]
08/25/2023

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

構文

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

パラメーター

[in] unnamedParam1

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

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

[in] unnamedParam2

電話帳エントリに関連付ける接続パラメーターを指定する RASDIALPARAMS 構造体へのポインター。 RasSetEntryDialParams は、構造体のメンバーを次のように使用します。

メンバー	意味
dwSize	構造体のバージョンを識別するには、 (RASDIALPARAMS) のサイズを指定する必要があります。
szEntryName	パラメーターを設定する電話帳エントリを識別する null で終わる文字列。
szPhoneNumber	使用されていません。 NULL に設定します。
szCallbackNumber	コールバック電話番号を含む null で終わる文字列。 szCallbackNumber が空の文字列 ( "" ) の場合、コールバック番号は変更されません。
szUserName	このエントリに関連付けられているユーザーのログオン名を含む null で終わる文字列。 szUserName が空の文字列の場合、ユーザー名は変更されません。
szPassword	szUserName で指定されたユーザーのパスワードを含む null で終わる文字列。 szUserName が空の文字列の場合、パスワードは変更されません。 szPassword が空の文字列で、fRemovePassword が FALSE の場合、パスワードは空の文字列に設定されます。 fRemovePassword が TRUE の場合、szUserName で指定されたユーザーのこの電話帳エントリに格納されているパスワードは、szPassword 文字列の内容に関係なく削除されます。 Windows NT 4.0: パスワードは、szUserName が空の文字列であるかどうかに関係なく、szPassword で指定された文字列に変更されます。 Windows XP/2000: szPassword に RasGetCredentials または RasGetEntryDialParams によって返されるパスワードハンドルが含まれている場合、RasSetEntryDialParams は現在保存されているパスワードを変更せずに正常に返されます。
szDomain	ログオンするドメインの名前を含む null で終わる文字列。 szDomain が空の文字列の場合、ドメイン名は変更されません。
dwSubEntry	接続を確立するときにダイヤルする初期サブエントリの (1 から始まる) インデックスを指定します。
dwCallbackId	RAS が RasDialFunc2 コールバック関数に渡すアプリケーション定義の値を指定します。

[in] unnamedParam3

lprasdialparams-szUserName> で示されるユーザーの電話帳エントリの保存されたパスワードを削除するかどうかを指定します。 fRemovePassword が TRUE の場合、パスワードは削除されます。 fRemovePassword を TRUE に設定することは、ダイヤルアップネットワークの [パスワードの保存解除] チェックボックスをオンにすることと同じです。電話帳エントリのパスワードまたはその他のプロパティを設定する場合は、 fRemovePassword を FALSE に設定 します。

戻り値

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

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

値	説明
ERROR_BUFFER_INVALID	lprasdialparams で指定されたアドレスまたはバッファーが無効です。
ERROR_CANNOT_OPEN_PHONEBOOK	電話帳が破損しているか、コンポーネントが見つかりません。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	電話帳エントリが存在しません。

注釈

新しい電話帳エントリを作成するには、 RasSetEntryProperties 関数を使用します。

Windows XP 以降: RasSetEntryDialParams 関数は使用しないでください。電話帳エントリの資格情報を設定するには、 RasSetCredentials 関数を使用します。 RASDIALPARAMS 構造体内の RASDIALPARAMS の非資格情報メンバー (szCallbackNumber、dwSubEntry、dwCallbackId など) を、RasDial 関数にパラメーターとして渡される RASDIALPARAMS 構造体に直接設定します。

注意

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

要件

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