GetPrivateProfileIntW 関数 (winbase.h)
初期化ファイルの指定したセクションのキーに関連付けられている整数を取得します。
構文
UINT GetPrivateProfileIntW(
[in] LPCWSTR lpAppName,
[in] LPCWSTR lpKeyName,
[in] INT nDefault,
[in] LPCWSTR lpFileName
);
パラメーター
[in] lpAppName
初期化ファイル内のセクションの名前。
[in] lpKeyName
値を取得するキーの名前。 この値は文字列の形式です。 GetPrivateProfileInt 関数は、文字列を整数に変換し、整数を返します。
[in] nDefault
初期化ファイルにキー名が見つからない場合に返される既定値。
[in] lpFileName
初期化ファイルの名前。 このパラメーターにファイルへの完全なパスが含まれていない場合、システムは Windows ディレクトリ内のファイルを検索します。
戻り値
戻り値は、指定した初期化ファイル内の指定したキー名に続く文字列と等価の整数です。 キーが見つからない場合、戻り値は指定された既定値です。
解説
この関数は、lpAppName パラメーターで指定されたセクション名の下で lpKeyName パラメーターで指定された名前と一致するキーをファイルで検索します。 初期化ファイルのセクションには、次の形式が必要です。
[section]
key=value
.
.
.
GetPrivateProfileInt 関数では大文字と小文字は区別されません。lpAppName と lpKeyName の文字列は、大文字と小文字の組み合わせにすることができます。
アプリケーションは GetProfileInt 関数を使用して、Win.ini ファイルから整数値を取得できます。
システムは、次のレジストリ キーで定義されているマッピングを使用して、ほとんどの .ini ファイル参照をレジストリにマップします:HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping
このマッピングは、アプリケーションがシステム コンポーネントの初期化ファイル (Control.ini、System.ini、Winfile.ini など) を変更する場合に発生する可能性があります。 このような場合、関数は初期化ファイルからではなく、レジストリから情報を取得します。ストレージの場所の変更は、関数の動作には影響しません。
プロファイル関数では、次の手順を使用して初期化情報を検索します。
- IniFileMapping キーの下にある初期化ファイルの名前をレジストリで探します。
- lpAppName で指定されたセクション名を探します。 これは、初期化ファイルの名前を持つキーの名前付き値、またはこの名前を持つサブキーになります。または、名前が値またはサブキーとして存在しません。
- lpAppName で指定されたセクション名が名前付き値の場合、その値はレジストリ内のセクションのキーを検索する場所を指定します。
- lpAppName で指定されたセクション名がサブキーの場合、そのサブキーの名前付き値は、レジストリ内のセクションのキーを検索する場所を指定します。 探しているキーが名前付き値として存在しない場合は、キーを検索するレジストリの既定の場所を指定する名前のない値 (名前>なし)< が表示されます。
- lpAppName で指定されたセクション名が名前付き値またはサブキーとして存在しない場合は、名前のない値 (名前>なしとして<表示) があり、レジストリ内でセクションのキーを検索する既定の場所を指定します。
- セクション名のサブキーまたはエントリがない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。
- ! - この文字により、すべての書き込みがレジストリとディスク上の .ini ファイルの両方に強制的に移動されます。
- # - この文字により、新しいユーザーがセットアップ後に初めてログインしたときに、レジストリ値が Windows 3.1 .ini ファイルの値に設定されます。
- @ - この文字は、要求されたデータがレジストリに見つからない場合に、ディスク上の .ini ファイルに読み取りが行われるのを防ぎます。
- USR: - このプレフィックスは HKEY_CURRENT_USERを表し、プレフィックスの後のテキストはそのキーに対して相対的です。
- SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWAREを表し、プレフィックスの後のテキストはそのキーに対して相対的です。
注意
winbase.h ヘッダーは、GetPrivateProfileInt をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | winbase.h (Windows.h を含む) |
Library | Kernel32.lib |
[DLL] | Kernel32.dll |