RasSetEntryPropertiesA 関数 (ras.h)

  • [アーティクル]

RasSetEntryProperties 関数は、電話帳のエントリの接続情報を変更するか、新しい電話帳エントリを作成します。

構文

DWORD RasSetEntryPropertiesA(
  [in] LPCSTR      unnamedParam1,
  [in] LPCSTR      unnamedParam2,
  [in] LPRASENTRYA unnamedParam3,
  [in] DWORD       unnamedParam4,
  [in] LPBYTE      unnamedParam5,
  [in] DWORD       unnamedParam6
);

パラメーター

[in] unnamedParam1

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

[in] unnamedParam2

エントリ名を指定する null で終わる文字列へのポインター。

エントリ名が既存のエントリと一致する場合、 RasSetEntryProperties はそのエントリのプロパティを変更します。

エントリ名が既存のエントリと一致しない場合、 RasSetEntryProperties は新しい電話帳エントリを作成します。 新しいエントリの場合は、 RasValidateEntryName 関数を呼び出して、 RasSetEntryProperties を呼び出す前にエントリ名を検証します。

[in] unnamedParam3

lpszEntry パラメーターによって示される phone-book エントリに関連付ける新しい接続データを指定する RASENTRY 構造体へのポインター。

呼び出し元は 、RASENTRY 構造体の次のメンバーの値を指定する必要があります。

  • dwSize
  • szLocalPhoneNumber
  • szDeviceName
  • szDeviceType
  • dwFramingProtocol
  • dwfOptions
  • dwType
Windows XP 以降: dwType がサポートされています。

これらのメンバーに値が指定されていない場合、 RasSetEntryProperties は ERROR_INVALID_PARAMETERで失敗します。

構造体の後に、null で終わる代替電話番号文字列の配列が続く場合があります。 最後の文字列は、2 つの連続する null 文字で終了します。 RASENTRY 構造体の dwAlternateOffset メンバーには、最初の文字列へのオフセットが含まれています。

[in] unnamedParam4

lpRasEntry パラメーターによって識別されるバッファーのサイズをバイト単位で指定します。

[in] unnamedParam5

デバイス固有の構成情報を指定するバッファーへのポインター。 これは不透明な TAPI デバイス構成情報です。 TAPI デバイス構成の詳細については、Platform SDK のテレフォニー アプリケーション プログラミング インターフェイス (TAPI) の lineGetDevConfig 関数を参照してください。

Windows XP: このパラメーターは使用されません。 呼び出し元の関数では、このパラメーターを NULL に設定する必要があります。

[in] unnamedParam6

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

Windows XP: このパラメーターは使用されません。 呼び出し元の関数では、このパラメーターを 0 に設定する必要があります。

戻り値

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

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

値 意味
ERROR_ACCESS_DENIED
 ユーザーに正しい特権がありません。 管理者のみがこのタスクを完了できます。
ERROR_BUFFER_INVALID
 lpRasEntry で指定されたアドレスまたはバッファーが無効です。
ERROR_CANNOT_OPEN_PHONEBOOK
 電話帳が破損しているか、コンポーネントが見つかりません。
ERROR_INVALID_PARAMETER
 lpRasEntry パラメーターが指す RASENTRY 構造体に適切な情報が含まれていないか、指定されたエントリが電話帳に存在しません。 必要な情報については、 lpRasEntry の説明を参照してください。

注釈

すべてのユーザー接続のプロパティを設定するときに、呼び出し元のアプリケーションで phone-book パラメーター lpszPhonebook に NULL 以外の値が指定されている場合、電話帳ファイルは、すべてのユーザー アプリケーション データ パスの下にある電話帳ディレクトリに配置する必要があります。 電話帳ファイルの正しい場所を取得するには、最初に CSIDL 値をCSIDL_COMMON_APPDATAして SHGetFolderPath を呼び出します。 SHGetFolderPath は、すべてのユーザー のアプリケーション データ パスを返します。 このパスに次の文字列を追加します。

Microsoft\Network\Connections\Pbk

結合されたパスは、電話帳ファイルの正しい場所です。

メモlpszPhonebook パラメーターに NULL 以外の値を指定することは、Windows XP より後のバージョンの Windows ではサポートされない場合があります。
 

注意

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

要件

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

こちらもご覧ください

RASENTRY

RasCreatePhonebookEntry

RasGetEntryProperties

RasValidateEntryName

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

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