RasGetSubEntryPropertiesA 関数 (ras.h)

[アーティクル]
11/20/2024

RasGetSubEntryProperties 関数は、指定された電話帳エントリのサブエントリに関する情報を取得します。

構文

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

パラメーター

[in] unnamedParam1

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

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

[in] unnamedParam2

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

[in] unnamedParam3

サブエントリの 1 から始まるインデックスを指定します。

[in, out] unnamedParam4

RASSUBENTRY 構造体へのポインター。代替電話番号リストがある場合は、その後に追加のバイトが続きます。

出力時に、構造体は指定されたサブエントリに関する情報を受け取ります。

入力時に、dwSize メンバーは構造体のサイズを指定します。サイズは、構造体のバージョンを識別します。 sizeof(RASSUBENTRY) を使用してこのサイズを取得します。

このパラメーターは NULLできます。

[in, out] unnamedParam5

lpRasSubEntry バッファーのサイズ (バイト単位) を入力時に指定する変数へのポインター。

出力時に、変数は返されたバイト数、またはバッファーが小さすぎる場合に必要なバイト数を受け取ります。

lpRasSubEntry が NULL場合、このパラメーターは NULL できます。

[in] unnamedParam6

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

[in] unnamedParam7

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

戻り値

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

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

価値	意味
ERROR_INVALID_PARAMETER	関数が無効なパラメーターで呼び出されました。
ERROR_BUFFER_INVALID	lpRasSubEntry で指定アドレスまたはバッファーが無効です。
ERROR_BUFFER_TOO_SMALL	lpRasSubEntry バッファーが小さすぎます。 lpdwcb 変数は、必要なバッファーサイズを受け取ります。
ERROR_CANNOT_OPEN_PHONEBOOK	電話帳が破損しているか、コンポーネントがありません。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	電話帳のエントリが存在しません。

備考

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

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

手記

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

必要条件

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

次の方法で共有

RasGetSubEntryPropertiesA 関数 (ras.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース