RasGetAutodialParamA 関数 (ras.h)

  • [アーティクル]

RasGetAutodialParam 関数は、AutoDial パラメーターの値を取得します。

構文

DWORD RasGetAutodialParamA(
  [in]      DWORD   unnamedParam1,
  [out]     LPVOID  unnamedParam2,
  [in, out] LPDWORD unnamedParam3
);

パラメーター

[in] unnamedParam1

取得する AutoDial パラメーターを指定します。 このパラメーターには、次の値のいずれかを指定できます。

値 意味
RASADP_DisableConnectionQuery
 lpvValue パラメーターは DWORD 値を返します。 この値が 0 (既定値) の場合、AutoDial は、接続を作成する前にユーザーにクエリを実行するダイアログ ボックスを表示します。 この値が 1 で、AutoDial データベースにダイヤルする電話帳エントリがある場合、AutoDial はダイアログ ボックスを表示せずに接続を作成します。
RASADP_LoginSessionDisable
 lpvValue パラメーターは DWORD 値を返します。 この値が 1 の場合、システムは現在のログオン セッションのすべての自動ダイヤル接続を無効にします。 この値が 0 (既定値) の場合、自動ダイヤル接続が有効になります。 AutoDial システム サービスは、新しいユーザーがワークステーションにログオンすると、この値を 0 に変更します。
RASADP_SavedAddressesLimit
 lpvValue パラメーターは、AutoDial がレジストリに格納するアドレスの最大数を示す DWORD 値を返します。 AutoDial は、AutoDial 接続の作成に使用したアドレスを最初に格納します。その後、RAS 接続の作成後に学習したアドレスが格納されます。 RasSetAutodialAddress 関数を使用して記述されたアドレスは常に保存され、制限の計算には含まれません。 既定値は 100 です。
RASADP_FailedConnectionTimeout
 lpvValue パラメーターは、タイムアウト値を示す DWORD 値を秒単位で返します。 AutoDial 接続の試行が失敗すると、AutoDial システム サービスは、タイムアウト期間に同じアドレスに到達する後続の試行を無効にします。 これにより、AutoDial では、アプリケーションによる同じ論理要求に対して複数の接続ダイアログ ボックスが表示されなくなります。 既定値は 5 です。
RASADP_ConnectionQueryTimeout
 lpvValue パラメーターは、タイムアウト値 (秒単位) を示す DWORD 値を指します。 自動ダイヤル接続を試行する前に、システムにダイヤルする必要があることをユーザーに確認するように求めるダイアログが表示されます。 このダイアログにはカウントダウン タイマーがあり、ユーザーが何も操作を行わない場合は[ダイヤルしない]を選択してダイアログを終了します。 lpvValue が指す DWORD 値は、このカウントダウン タイマーの初期時刻を指定します。

[out] unnamedParam2

指定したパラメーターの値を受け取るバッファーへのポインター。

[in, out] unnamedParam3

DWORD 値へのポインター。

入力時に、 lpvValue バッファーのサイズ (バイト単位) を示すようにこの値を設定します。

出力時に、この値はバッファーに書き込まれた値の実際のサイズを示します。

戻り値

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

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

値 意味
ERROR_INVALID_PARAMETER
 dwKey または lpvValue パラメーターが無効です。
ERROR_INVALID_SIZE
 lpdwcbValue で指定されたサイズが小さすぎます。

注釈

注意

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

要件

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

こちらもご覧ください

RasSetAutodialAddress

RasSetAutodialParam

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

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