RasSetEntryDialParamsA 関数 (ras.h)

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

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場合、szPassword 文字列の内容に関係なく、szUserName で指定されたユーザーのこの電話帳エントリに格納されているパスワードが削除されます。 Windows NT 4.0: パスワードは、szUserName が空の文字列であるかどうかに関係なく、szPassword で指定された文字列に変更されます。 Windows XP/2000: szPassword に、現在保存されているパスワードを変更せずに、RasGetCredentials または RasGetEntryDialParamsRasSetEntryDialParams によって返されるパスワードハンドルが含まれている場合正常に返されます。
szDomain	ログオンするドメインの名前を含む null で終わる文字列。 szDomain が空の文字列の場合、ドメイン名は変更されません。
dwSubEntry をする	接続を確立するときにダイヤルする初期サブエントリの (1 から始まる) インデックスを指定します。
dwCallbackId をする	RAS が RasDialFunc2 コールバック関数に渡すアプリケーション定義の値を指定します。

[in] unnamedParam3

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

戻り値

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

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

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

備考

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

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

手記

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

必要条件

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

次の方法で共有

RasSetEntryDialParamsA 関数 (ras.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース