<Return[WXYZ]><Top>

WritePrivateProfileString

Declare Function Api_WritePrivateProfileString& Lib "kernel32" Alias "WritePrivateProfileStringA" (ByVal lpApplicationName$, ByVal lpKeyName As Any, ByVal lpString As Any, ByVal lpFileName$)

Declare Function WritePrivateProfileString Lib "kernel32" Alias "WritePrivateProfileStringA" (ByVal lpApplicationName As String, ByVal lpKeyName As Any, ByVal lpString As Any, ByVal lpFileName As String) As Long

指定された .ini ファイル(初期化ファイル)の、指定されたセクション内に、指定されたキー名とそれに関連付けられた文字列を格納する。

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

パラメータ
lpAppName
    文字列のコピー先となるセクションの名前を保持している、NULL で終わる文字列へのポインタを指定する。

    このセクションが存在しない場合、新しく作成される。このセクション名では、大文字と小文字を区別しない。

    文字列で、大文字と小文字の任意の組み合わせを指定できる。
lpKeyName
    文字列へ関連付けるべきキーの名前を保持している、NULL で終わる文字列へのポインタを指定する。

    指定されたセクション内にこのキーが存在していない場合、新しく作成される。

    NULL を指定すると、この関数は、そのセクション内のすべてのエントリを含めセクション全体を削除する。
lpString
    ファイルに書き込むべき、NULL で終わる文字列へのポインタを指定する。

    NULL を指定すると、この関数は、lpKeyName パラメータで指定されたキーを削除する。
    Windows 95:このパラメータの一部としてタブ文字(\t)を使うことはできない。
lpFileName
    .ini ファイルの名前を保持している、NULL で終わる文字列へのポインタを指定する。
 

戻り値
    関数が文字列を .ini ファイルに格納することに成功すると、0 以外の値が返る。
    関数が失敗するか、直前にアクセスした .ini ファイルをキャッシュからディスク上のファイルへフラッシュする(書き込む)と、0 が返る。

    拡張エラー情報を取得するには、GetLastError 関数を使う。