RasSetSubEntryPropertiesA 関数 (ras.h)

  • [アーティクル]

RasSetSubEntryProperties 関数は、新しいサブエントリを作成するか、指定した電話帳エントリの既存のサブエントリを変更します。

構文

DWORD RasSetSubEntryPropertiesA(
  [in] LPCSTR         unnamedParam1,
  [in] LPCSTR         unnamedParam2,
  [in] DWORD          unnamedParam3,
  [in] LPRASSUBENTRYA unnamedParam4,
  [in] DWORD          unnamedParam5,
  [in] LPBYTE         unnamedParam6,
  [in] DWORD          unnamedParam7
);

パラメーター

[in] unnamedParam1

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

Windows Me/98/95: このパラメーターは常に NULL にする必要があります。 ダイヤルアップ ネットワークでは、電話帳ファイルではなく、レジストリに電話帳エントリが格納されます。

[in] unnamedParam2

電話帳内の既存のエントリの名前を指定する null で終わる文字列へのポインター。

[in] unnamedParam3

サブエントリの 1 から始まるインデックスを指定します。 インデックスが既存のサブエントリ インデックスと一致する場合、関数はそのサブエントリのプロパティを変更します。 インデックスが既存のインデックスと一致しない場合、関数は新しいサブエントリを作成します。

[in] unnamedParam4

サブエントリのデータを指定する RASSUBENTRY 構造体へのポインター。

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

[in] unnamedParam5

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

[in] unnamedParam6

TAPI デバイス構成ブロックへのポインター。 このパラメーターは現在使用されていません。 呼び出し元は、このパラメーターに NULL を 渡す必要があります。 TAPI デバイス構成ブロックの詳細については、関数 行GetDevConfig に関するページを参照してください。

[in] unnamedParam7

TAPI デバイス構成ブロックのサイズを指定します。 このパラメーターは現在使用されていません。 呼び出し元は、このパラメーターに対して 0 を渡す必要があります。

戻り値

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

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

値 意味
ERROR_BUFFER_INVALID
 lpRasEntry で指定されたアドレスまたはバッファーが無効です。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 電話帳エントリが存在しません。
ERROR_CANNOT_OPEN_PHONEBOOK
 電話帳が破損しているか、コンポーネントが見つかりません。
ERROR_INVALID_PARAMETER
 関数が無効なパラメーターで呼び出されました。

注釈

RAS 電話帳エントリには、デバイスと電話番号で構成されるサブエントリを 0 個以上指定できます。 複数のサブエントリを含む電話帳エントリは、エントリのダイヤル時に最初に使用可能なサブエントリまたはすべてのサブエントリをダイヤルするように構成できます。

RasGetEntryProperties 関数を使用して、電話帳エントリのサブエントリに関する情報を含む RASENTRY 構造体を取得します。 dwSubEntries メンバーはサブエントリの数を示し、dwDialMode メンバーはダイヤル構成を示します。

注意

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

要件

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

こちらもご覧ください

RASENTRY

RASSUBENTRY

RasGetEntryProperties

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

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