<Return[G]><Top>

GetPrivateProfileInt

Declare Function Api_GetPrivateProfileInt& Lib "Kernel32" Alias "GetPrivateProfileIntA" (ByVal lpAppName$, ByVal lpKeyName$, ByVal nDefault&, ByVal lpFileName$)

Declare Function GetPrivateProfileInt Lib "kernel32" Alias "GetPrivateProfileIntA" (ByVal lpApplicationName As String, ByVal lpKeyName As String, ByVal nDefault As Long, ByVal lpFileName As String) As Long

指定された .ini ファイル(初期化ファイル)の指定されたセクション内にある、指定されたキーに関連付けられている整数を取得する。

この関数は、16 ビット Windows ベースのアプリケーションとの互換性を保つ目的でのみ提供されている。Win32 ベースのアプリケーションでは、初期化情報をレジストリに格納する。

パラメータ
lpAppName
    .ini ファイル内のセクションの名前を保持している、NULL で終わる文字列へのポインタを指定する。
lpKeyName
    キーの名前を保持している、NULL で終わる文字列へのポインタを指定する。

    この関数は、このキーの値を取得する。各キーの値は、文字列形式である。

    GetPrivateProfileInt 関数は、この文字列を整数へ変換し、その整数を返す。
nDefault
    指定したキーが .ini ファイル内で見つからなかったときに返すべき、既定の値を指定する。
lpFileName
    初期化ファイルの名前を保持している、NULL で終わる文字列へのポインタを指定する。

    ファイルのフルパス名を指定しなかった場合、システムは Windows ディレクトリ内でこのファイルを検索する。
 

戻り値
    関数が成功すると、指定した .ini ファイルの指定したセクション内にある、指定したキーに関連付けられている文字列に相当する整数が返

    る。

    指定したキーが見つからない場合、nDefault パラメータで指定した既定の値が返る。キーの値が負の場合、0 が返る。