iniファイルを操作するためのAPI(メモ)

【ご注意】ここに書かれている情報は古い情報となっています。ご利用になる場合は古い情報であるとご認識いただき参考にとどめ、最新の情報はマイクロソフト社の公式の最新情報等をお探しください。

■GetPrivateProfileString

　iniファイルから値を読み出します。

DWORD GetPrivateProfileString( LPCTSTR lpAppName, LPCTSTR lpKeyName, LPCTSTR lpDefault, LPTSTR lpReturnedString, DWORD nSize, LPCTSTR lpFileName );

●引数

　lpAppName … セクション名を指定します。セクション名とは "[" と "]" で囲まれた部分のことですが、ここでは "[" や "]" を含めてはいけません。
　lpKeyName … キーの名前(=の左側)を指定します。ここでNULLを指定されるとセクション中の全てのキーの名前をNULL区切りでlpReturnedStringに代入します。終端はNULLが2つで終わります。
　lpDefault … 指定されたセクションとキーが存在しなかった場合、どういう値を返すか(デフォルトとすべきか)を指定します。
　lpReturnedString … ここに、取得された文字列が格納されます。
　nSize … lpReturnedStringが指すバッファのサイズを指定します。これを超えた場合、値の残りの部分は切り捨てられます。
　lpFileName … iniファイル名を指定します。パスが指定されなかった場合は、Windowsフォルダが指定されたものと見なします。カレントフォルダを指定したい場合は、ファイル名の前に .\ を付けると良いでしょう。

●戻り値

　取得された文字列の長さが返されます。終端の\0は含まれません。
　バッファのサイズが足りなかった場合、lpReturnedStringに格納される文字列は途中から切り捨てられ、lpKeyName==NULL の場合は nSize-2 が、lpKeyName!=NULL の場合は nSize-1 が返されます。
　プログラムはこの値を受け取ったら、バッファのサイズを適当に増やして再度読み込みを試行することを繰り返すことで、任意の長さの文字列を取得することができます。

●注意

　この関数は過去のWindowsとの互換を保つために残されています。Win32プログラムでは、設定は大きすぎない限り、レジストリに格納することが奨められています。
　Windows 95では、セクションのサイズは32KB(32767文字)に制限されます。

　戻る

※このページは、ソフトウェアに付属のヘルプファイルをWeb用に再構築したものです。大部分に自動変換を施しているため、一部は正しく変換しきれずに表示の乱れている箇所があるかもしれませんが、ご容赦下さい。また、本ドキュメントはアーカイブドキュメントであり、内容は「いじくるつくーる」最終公開時点、あるいは、それより古い時点のものとなっております。一部、内容が古くなっている箇所があるかと思いますが、あらかじめご了承下さい。
※このページへは、自由にリンクしていただいてかまいません。
このページに関するご意見の受け付けは終了しています。

/トップ/いじくるつくーる/ダウンロード/WebHelp/ヘルプトップ/