RasSetAutodialAddressA 関数 (ras.h)

  • [アーティクル]

RasSetAutodialAddress 関数は、AutoDial マッピング データベースにアドレスを追加できます。 または、関数は、データベース内の既存のアドレスに関連付けられているデータを削除または変更できます。

構文

DWORD RasSetAutodialAddressA(
  [in] LPCSTR              unnamedParam1,
  [in] DWORD               unnamedParam2,
  [in] LPRASAUTODIALENTRYA unnamedParam3,
  [in] DWORD               unnamedParam4,
  [in] DWORD               unnamedParam5
);

パラメーター

[in] unnamedParam1

追加、削除、または変更するアドレスを指定する null で終わる文字列へのポインター。 このアドレスには、IP アドレス、インターネット ホスト名 ("www.microsoft.com")、または NetBIOS 名 ("products1") を指定できます。

このパラメーターが NULL の場合、関数は既定のインターネット接続を設定します (「解説」を参照)。 このパラメーターが長さ 0 の文字列を指している場合、関数は既定のインターネット接続を削除します。

[in] unnamedParam2

予約;は 0 である必要があります。

[in] unnamedParam3

lpszAddress アドレスに関連付ける 1 つ以上の RASAUTODIALENTRY 構造体の配列へのポインター。 lpAutoDialEntries が NULL で、dwcbAutoDialEntries が 0 の場合、RasSetAutodialAddress は lpszAddress に関連付けられているすべての構造体をマッピング データベースから削除します。

[in] unnamedParam4

lpAutoDialEntries バッファーのサイズをバイト単位で指定します。

[in] unnamedParam5

lpAutoDialEntries バッファー内の RASAUTODIALENTRY 構造体の数を指定します。

戻り値

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

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

値 意味
ERROR_INVALID_SIZE
 RASAUTODIALENTRY 構造体の dwSize メンバーが無効な値です。
ERROR_INVALID_PARAMETER
 lpszAddress パラメーターは NULL です。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 lpAutoDialEntries で指定された接続名が存在しません。

注釈

AutoDial マッピング データベース内のアドレスには、任意の数の RASAUTODIALENTRY エントリを関連付けることができます。 各エントリは、特定の TAPI ダイヤルの場所の自動ダイヤル情報を指定します。

lpszAddress パラメーターで指定されたアドレスがデータベース内の既存のアドレスであり、lpAutoDialEntries パラメーターが NULL でない場合、RasSetAutodialAddress 関数はアドレスに関連付けられている AutoDial エントリのセットを変更します。 lpAutoDialEntries 配列のエントリで、アドレスにエントリが既に含まれているダイヤル位置が指定されている場合、関数は既存のエントリを新しいエントリに置き換えます。 それ以外の場合、関数は lpAutoDialEntries エントリをアドレスの一連のエントリに追加するだけです。

lpszAddress アドレスがデータベースに存在し、lpAutoDialEntries が NULL で、lpAutoDialEntries が 0 の場合、RasSetAutodialAddress はデータベースからアドレスを削除します。

lpszAddress アドレスがデータベースに存在しない場合、RasSetAutodialAddress はアドレスをデータベースに追加します。 lpAutoDialEntries パラメーターは、新しいアドレスに関連付ける AutoDial エントリを指定します。

RAS は、ローカル コンピューターへのグローバルな既定のインターネット接続をサポートし、各ユーザーの既定のインターネット接続をサポートします。

lpszAddress パラメーターが NULL で、lpAutoDialEntries パラメーターが 1 つのエントリを持つ接続名を指定すると、RasSetAutodialAddress は接続を既定のインターネット接続として設定します。 lpAutoDialEntries で指定された接続名は既に存在している必要があります。 そうでない場合は、 ERROR_CANNOT_FIND_PHONEBOOK_ENTRY が返されます。

lpszAddress パラメーターが長さ 0 の文字列で、lpAutoDialEntries パラメーターが 1 つのエントリを持つ空の接続名を指定すると、RasSetAutodialAddress は既定のインターネット接続を削除します。

ドメイン以外のクライアント コンピューターでは、ユーザーが既定のインターネット接続として接続を設定し、RASAUTODIALENTRY 構造体の szEntry メンバーに "for-all-users" 接続を指定した場合、既定のインターネット接続はローカル コンピューターでグローバルに設定されます。 それ以外の場合は、コンピューターの各ユーザーに対して既定のインターネット接続が個別に設定されます。

1 つが "for-all-users" 接続として構成され、もう一方が "for-me-only" 接続として構成されている場合は、同じ名前の 2 つの接続を持つことができます。 lpAutoDialEntries パラメーターで、グローバル接続とユーザーごとの接続の両方に対応する接続名を指定すると、ユーザーごとの接続が設定されます。

注意

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

要件

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

こちらもご覧ください

RASAUTODIALENTRY

RasEnumAutodialAddresses

RasGetAutodialAddress

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

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