GetPrivateProfileSection / WritePrivateProfileSection의 C# 버전

상기시킬 겸, 예전에 쓴 INI 파일의 인코딩 관련 문제를 링크 걸어보고 시작하겠습니다. ^^

UTF-8 포맷의 INI 파일에 대한 GetPrivateProfile... API 사용 불가
; https://www.sysnet.pe.kr/2/0/927

최근 C#에서 INI 파일의 Section 영역을 다루다가 한 가지 더 작은 문제가 생겼습니다.

보통 INI 파일의 경우 다음과 같이 정보를 저장하게 되는데요.

[TestSection]
Key1 = Value1
Key2 = Value2

가끔, 해당 Section 내에 정의된 Key 이름을 열람하고 싶을 때가 있는데, 아쉽게도 Win32 API 중에서 그런 용도로 제공되는 함수는 없습니다. 단지, 전체 Key/Value 쌍을 반환하는 함수가 있는데, GetPrivateProfileSection Win32 API가 그런 역할을 합니다.

DWORD WINAPI GetPrivateProfileSection(LPCTSTR lpAppName, LPTSTR lpReturnedString, DWORD nSize, LPCTSTR lpFileName);

이 함수는 각각의 Key/Value 쌍을 '\0' NULL 값으로 구분하고 마지막 항목에서 이중 NULL 값을 채움으로써 목록의 마지막임을 알립니다.

즉, 위와 같은 경우에 다음과 같은 문자열 값으로 다뤄지게 됩니다. (읽기 함수에서는 마지막 '\0' NULL 문자가 없지만, 쓰기 함수에서는 마지막 '\0' NULL 문자를 처리해 주어야 합니다.)

Key1=Value1\0Key2=Value2\0\0

C/C++의 경우에는 어차피 2번째 인자인 "LPTSTR lpReturnedString" 값이 포인터이다 보니 '\0' NULL 값을 제어하는데 아무런 문제가 없지만, C#에서는 NULL 값 제어를 할 수 없으므로 일반적인 System.Text.StringBuilder 개체로 마샬링을 해서는 안됩니다. (물론, 해도 되지만 그렇게 되면 무조건 첫 번째 Key1=Value1 값만을 반환하게 됩니다.)

이 문제를 해결하기 위해서는 다음과 같이 그냥 byte[] 값으로 P/Invoke 구문을 만드는 것이 좋습니다.

[DllImport(kernel32.dll)]
private static extern int GetPrivateProfileSection(
            String appName, byte [] returnValue, int size, String filePath);

그리고, 이를 사용해서 다음과 같이 byte[] 배열을 대상으로 '\0' NULL 처리를 할 수 있는 wrapper 함수를 만들어 두면 되겠고.

static void Main(string[] args)
{
    Dictionary<string, string> keyValues = GetKeyValuesInSection(@"D:\temp\Test.ini", "TestSection");
}
        
private static Dictionary<string, string> GetKeyValuesInSection(string iniPath, string sectionName)
{
    Dictionary<string, string> keyValues = new Dictionary<string, string>();
    byte[] returnValue = new byte[32768 * 2];
    int byteCount = GetPrivateProfileSection(sectionName, returnValue, 32768 * 2, iniPath);

    int pos = 0;
    while (true)
    {
        if (pos >= byteCount)
        {
            break;
        }

        int count = 0;
        while (true)
        {
            if (returnValue[pos + count] == 0)
            {
                break;
            }

            count++;
        }

        string txt = Encoding.Default.GetString(returnValue, pos, count);

        int equalPos = txt.IndexOf('=');
        if (equalPos == -1)
        {
            keyValues.Add(txt, "");
        }
        else
        {
            keyValues.Add(txt.Substring(0, equalPos), txt.Substring(equalPos + 1));
        }

        pos += count + 1;
    }

    return keyValues;
}

위에서 보면 바이트 배열의 크기를 32767로 했는데요. 왜냐하면 MSDN 문서에 다음과 같이 설명되어 있기 때문입니다.

GetPrivateProfileSection function
; https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-getprivateprofilesection

---

그런데, 왜? 32767에 곱하기 2를 했을까요? 그 해답은 이 글의 처음에 링크했던 바와 같이 INI 파일의 포맷이 ANSI와 UNICODE를 함께 지원하기 때문입니다. 그렇게 생각하면 위에서 제가 제공해드린 예제 함수(GetKeyValuesInSection)에는 헛점이 너무나 많습니다. 왜냐하면 유니코드의 경우라면 일반 ASCII 문자에 대해서 '\0' NULL 문자가 올 수 있기 때문에 이를 감안해야 하고, 게다가 Encoding.Default로 문자열을 구해와서도 안됩니다.

하지만, 위의 함수는 ANSI와 Unicode INI 파일에 대해서 잘 동작합니다. 왜일까요?

이 함수를 통해서 재미있는 사실을 알게 되었는데요. 한글 테스트를 위해 다음과 같은 내용의 UNICODE INI 파일을 생성하고,

[TestSection] 
Key1=Value1
한글키=한글값

반환되는 바이트 값을 출력해 보았습니다.

int byteCount = GetPrivateProfileSection(sectionName, returnValue, 32768 * 2, iniPath);

#if DEBUG
    Console.WriteLine("GetPrivateProfileSection: " + byteCount);
    Console.WriteLine(BitConverter.ToString(returnValue, 0, byteCount));
    Console.WriteLine();
#endif

결과는 매우 의외였습니다.

GetPrivateProfileSection: 26
4B-65-79-31-3D-56-61-6C-75-65-31-00-C7-D1-B1-DB-C5-B0-3D-C7-D1-B1-DB-B0-AA-00

분석:

4B-65-79-31-3D-56-61-6C-75-65-31-00
k  e  y  1  =  v  a  l  u  e  1  \0

C7-D1-B1-DB-C5-B0-3D-C7-D1-B1-DB-B0-AA-00
한    글    키     = 한    글    값    \0

즉, GetPrivateProfileSection 함수는 WBCS(Wide Byte Character Set) 형식으로 반환하지 않고 MBCS(Multi Byte Character Set) 형식으로 반환하는 것이었습니다. 이렇다는 것은 곧, 만약 위의 INI 파일을 일본어 윈도우에서 실행한다면 정상적으로 값을 구할 수 없음을 뜻합니다. 실제로, Regional Settings를 영문으로만 바꿔도 다음과 같이 한글값이 '?' 문자로 깨져나옵니다.

GetPrivateProfileSection: 20
4B-65-79-31-3D-56-61-6C-75-65-31-00-3F-3F-3F-3D-3F-3F-3F-00

분석:

4B-65-79-31-3D-56-61-6C-75-65-31-00
k  e  y  1  =  v  a  l  u  e  1  \0

3F-3F-3F-3D-3F-3F-3F-00
?  ?  ?  =  ?  ?  ? \0

파일은 유니코드 형식인데, Win32 API가 MBCS 방식이라서 이런 현상이 생기는 것입니다. 허긴... 이에 대해서 마이크로소프트를 탓할 만한 것은 아닌 것 같습니다. 왜냐하면, INI 파일을 다루는 Win32 API들은 현재 16비트 윈도우 응용 프로그램을 위한 호환성만을 목적으로 제공된다고 문서에 명시되어 있기 때문입니다.

음... 그래도 그렇지... 가끔은 INI 파일에 설정값 저장하는 것이 은근히 편할 때가 있는데... ^^

첨부된 파일은 위의 코드를 포함한 예제 프로젝트입니다. GetPrivateProfileSection과 쌍을 이루는 WritePrivateProfileSection도 래퍼 함수를 구현해 놓았으니 참고하세요. ^^

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 2/19/2012]
[최종 수정일: 6/26/2021]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com