次の方法で共有

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場合、関数は現在の既定の電話帳ファイルを使用します。 既定の電話帳ファイルは、ダイヤルアップ ネットワーク] ダイアログ ボックスの [ユーザー設定 プロパティ シートでユーザーが選択したものです。

[in] unnamedParam2

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

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

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

[in] unnamedParam3

lpszEntry パラメーターで示される電話帳エントリに関連付ける新しい接続データを指定する RASENTRY 構造体へのポインター。

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

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

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

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

[in] unnamedParam4

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

[in] unnamedParam5

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

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

[in] unnamedParam6

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

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

戻り値

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

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

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

備考

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

Microsoft\Network\Connections\Pbk

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

注 Windows XP より後のバージョンの Windows では、lpszPhonebook パラメーターに以外の NULL 値を指定することはできません。
 

手記

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

必要条件

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

関連項目

RASENTRY を する

RasCreatePhonebookEntry

RasGetEntryProperties

RasValidateEntryName

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

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