RasGetEntryPropertiesA 関数 (ras.h)

  • [アーティクル]

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

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

[in] unnamedParam2

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

[in, out] unnamedParam3

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

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

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

このパラメーターは、NULL でもかまいません。

Windows Me/98 および Windows 95 OSR2: Unicode 用 Microsoft Layer では、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。

関数が失敗した場合、戻り値は次のいずれかのエラー コードか、 ルーティングとリモート アクセスのエラー コード または 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 ヘッダーは、RasGetEntryProperties をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

こちらもご覧ください

RASENTRY

RasSetEntryProperties

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

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