RasGetEntryPropertiesA 関数 (ras.h)

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

RasGetEntryProperties 関数は、電話帳エントリのプロパティを取得します。

構文

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

パラメーター

[in] unnamedParam1

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

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

[in] unnamedParam2

既存のエントリ名を指定する -terminated 文字列null へのポインター。空の文字列が指定されている場合、この関数は、lpRasEntry によって指されるバッファー内の既定値を返し、lpbDeviceInfo パラメーターをします。

[in, out] unnamedParam3

RASENTRY 構造体へのポインターの後に、代替電話番号リストの追加バイトが続きます (存在する場合)。

出力時に、構造体は、lpszEntry パラメーターで指定された電話帳エントリに関連付けられている接続データを受け取ります。

入力時に、構造体の dwSize メンバーを sizeof(RASENTRY) に設定して、構造体のバージョンを識別します。

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

Windows Me/98 および Windows 95 OSR2: Microsoft Layer for Unicode では、RASENTRYの dwAlternateOffset はサポートされていません。

[in, out] unnamedParam4

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

出力時に、この変数は必要なバイト数を受け取ります。

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

必要なバッファーサイズを決定するには、lpRasEntry を null に設定し、*lpdwEntryInfoSize を 0 に設定 RasGetEntryProperties を呼び出します。この関数は、*lpdwEntryInfoSize必要なバッファーサイズを返します。

[out] unnamedParam5

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

Windows Me/98/95: デバイス固有の構成情報を受け取るバッファーへのポインター。この不透明な TAPI デバイス情報を直接操作しないでください。 TAPI デバイス構成の詳細については、プラットフォーム SDK の TAPI プログラマーリファレンスの lineGetDevConfig 関数を参照してください。

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

[in, out] unnamedParam6

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

Windows Me/98/95: 入力時に、lpbDeviceInfo パラメーターで指定されたバッファーのサイズをバイト単位で指定する変数へのポインター。

出力時に、この変数は必要なバイト数を受け取ります。

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

必要なバッファーサイズを決定するには、lpbDeviceInfo を null に設定し、*lpdwDeviceInfoSize を 0 に設定 rasGetEntryProperties 呼び出します。この関数は、*lpdwDeviceInfoSize必要なバッファーサイズを返します。

戻り値

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

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

価値	意味
ERROR_INVALID_PARAMETER	関数が無効なパラメーターで呼び出されました。
ERROR_INVALID_SIZE	lpRasEntry の dwSize メンバーの値が小さすぎます。
ERROR_BUFFER_INVALID	lpRasEntry で指定アドレスまたはバッファーが無効です。
ERROR_BUFFER_TOO_SMALL	lpdwEntryInfoSize 示されているバッファーサイズが小さすぎます。
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	電話帳エントリが存在しないか、電話帳ファイルが破損しているか、コンポーネントが不足しています。

備考

手記

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

必要条件

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

次の方法で共有

RasGetEntryPropertiesA 関数 (ras.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース