INI ファイルに情報を保存する

アプリケーションで、次回の起動時も値を保持したいとき INI ファイルを使って値を保持できます。(レジストリを使う方法もありますが、今回は INI ファイルを扱います。)
Windows の API に INI ファイルへの読み書きを行うための API が用意されているので紹介します。

INI ファイルに情報を保存するには、下記の関数を使う。

WritePrivateProfileString 関数 – INI ファイルに情報を保存する

第1引数、INI ファイル内のセクション名(文字列)
第2引数、INI ファイル内のキー名(文字列)。キー名はセッション内でユニークである必要があります。
第3引数、INI ファイルに保存する値(文字列)
第4引数、INI ファイルのファイルパス(文字列)
戻り値、関数が成功すると 0 以外。
参考: https://msdn.microsoft.com/ja-jp/library/cc429952.aspx

INI ファイルから情報を読み込むには、下記の関数を使う。

GetPrivateProfileString 関数 – INI ファイルから文字列を読み込む
第1引数、INI ファイル内のセクション名(文字列)
第2引数、INI ファイル内のキー名(文字列)。キー名はセッション内でユニークである必要があります。
第3引数、値が取得できなかった場合のデフォルト値(文字列)
第4引数、読み込み先のバッファ(文字列)
第5引数、バッファの文字数(数値)
第6引数、INI ファイルのファイルパス(文字列)
戻り値、関数が成功すると、バッファに格納された文字数が返る。
参考: https://msdn.microsoft.com/ja-jp/library/cc429779.aspx

GetPrivateProfileInt 関数 – INI ファイルから整数値を読み込む
第1引数、INI ファイル内のセクション名(文字列)
第2引数、INI ファイル内のキー名(文字列)。キー名はセッション内でユニークである必要があります。
第3引数、値が取得できなかった場合のデフォルト値(数値)
第4引数、INI ファイルのファイルパス(文字列)
戻り値、指定したキーに関連付けられている文字列に相当する整数が返る。
指定したキーが見つからない場合は、nDefault パラメータで指定した既定の値が返る。
参考: https://msdn.microsoft.com/ja-jp/library/cc429763.aspx

以下サンプルプログラムです。
プロジェクトのダウンロード

#pragma comment(linker, "\"/manifestdependency:type='win32' name='Microsoft.Windows.Common-Controls' version='6.0.0.0' processorArchitecture='*' publicKeyToken='6595b64144ccf1df' language='*'\"")

#pragma comment(lib, "shlwapi")

#include <windows.h>
#include <shlwapi.h>

TCHAR szClassName[] = TEXT("Window");

LRESULT CALLBACK WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
{
	static HWND hButton1;
	static HWND hButton2;
	static TCHAR szINIFilePath[MAX_PATH];
	TCHAR szText[256];
	switch (msg)
	{
	case WM_CREATE:
		// INIファイルのパスを作成(exeの隣にする)
		GetModuleFileName(((LPCREATESTRUCT)lParam)->hInstance, szINIFilePath, MAX_PATH);
		PathRemoveExtension(szINIFilePath);
		PathAddExtension(szINIFilePath, TEXT(".ini"));
		// ボタンの作成
		hButton1 = CreateWindow(TEXT("BUTTON"), TEXT("INIファイル書き込み"),
			WS_VISIBLE | WS_CHILD, 10, 10, 256, 32, hWnd, (HMENU)100,
			((LPCREATESTRUCT)lParam)->hInstance, 0);
		hButton2 = CreateWindow(TEXT("BUTTON"), TEXT("INIファイル読み込み"),
			WS_VISIBLE | WS_CHILD, 10, 50, 256, 32, hWnd, (HMENU)101,
			((LPCREATESTRUCT)lParam)->hInstance, 0);
		break;
	case WM_COMMAND:
		if (LOWORD(wParam) == 100) // INIファイル書き込み
		{
#ifdef UNICODE
			// Unicode で書き込むためには、あらかじめ BOM を設定しておく必要があります。
			HANDLE hFile = CreateFile(szINIFilePath, GENERIC_WRITE, 0, NULL, CREATE_NEW, 0, NULL);
			if (hFile != INVALID_HANDLE_VALUE)
			{
				BYTE bom[2] = { 0xFF, 0xFE };
				DWORD dwWritten;
				WriteFile(hFile, bom, 2, &dwWritten, NULL);
				CloseHandle(hFile);
			}
#endif
			// 文字列をINIファイルに保存
			WritePrivateProfileString(TEXT("APP"), TEXT("VALUE1"), TEXT("あいうえお"), szINIFilePath);
			// 整数値をINIファイルに保存(実際には数値を書き込むAPIは無いので文字列に変換して保存)
			wsprintf(szText, TEXT("%d"), 123);
			WritePrivateProfileString(TEXT("APP"), TEXT("VALUE2"), szText, szINIFilePath);
		}
		else if (LOWORD(wParam) == 101) // INIファイル読み込み
		{
			// INIファイルから文字列を取得
			GetPrivateProfileString(TEXT("APP"), TEXT("VALUE1"), TEXT("DEFAULT"), szText, 256, szINIFilePath);
			MessageBox(hWnd, szText, TEXT("確認"), 0);
			// INIファイルから整数値を取得
			const int nValue = GetPrivateProfileInt(TEXT("APP"), TEXT("VALUE2"), -1, szINIFilePath);
			wsprintf(szText, TEXT("%d"), nValue);
			MessageBox(hWnd, szText, TEXT("確認"), 0);
		}
		break;
	case WM_DESTROY:
		PostQuitMessage(0);
		break;
	default:
		return DefWindowProc(hWnd, msg, wParam, lParam);
	}
	return 0;
}

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPreInst, LPSTR pCmdLine, int nCmdShow)
{
	MSG msg;
	WNDCLASS wndclass = {
		CS_HREDRAW | CS_VREDRAW,
		WndProc,
		0,
		0,
		hInstance,
		0,
		LoadCursor(0,IDC_ARROW),
		(HBRUSH)(COLOR_WINDOW + 1),
		0,
		szClassName
	};
	RegisterClass(&wndclass);
	HWND hWnd = CreateWindow(
		szClassName,
		TEXT("Window"),
		WS_OVERLAPPEDWINDOW,
		CW_USEDEFAULT,
		0,
		CW_USEDEFAULT,
		0,
		0,
		0,
		hInstance,
		0
	);
	ShowWindow(hWnd, SW_SHOWDEFAULT);
	UpdateWindow(hWnd);
	while (GetMessage(&msg, 0, 0, 0))
	{
		TranslateMessage(&msg);
		DispatchMessage(&msg);
	}
	return (int)msg.wParam;
}

追記(2018年3月2日)
Unicode 版の WritePrivateProfileString 関数で ini ファイルに Unicode 文字列を書き込む場合は注意が必要です。WritePrivateProfileString 関数を呼び出す前に、対象となる ini ファイルに BOM が設定されていないと Unicode ではなくShift-JIS で書き込まれるようです。ですので上記コードでは WritePrivateProfileString 関数の前に CreateFile 関数、WriteFile 関数、CloseHandle 関数を使って BOM を書き込むようにしました。


kenjinote

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

コメントする