From 76aa4b705671e406607ea3ddaca2566df2e2e7ad Mon Sep 17 00:00:00 2001
From: Colin Finck <c.finck@enlyze.com>
Date: Thu, 30 Nov 2023 16:33:47 +0100
Subject: [PATCH] Write a Byte Order Mark (BOM) to the CSV file.

This indicates UTF-8 and thereby fixes special characters when opening the resulting CSV in Excel.
To my knowledge, it has no negative effects in any application that works with CSV files.

Fixes #4
---
 src/csv_exporter.cpp | 11 +++++++++--
 src/version.h        |  2 +-
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/src/csv_exporter.cpp b/src/csv_exporter.cpp
index 6c07ad8..c441431 100644
--- a/src/csv_exporter.cpp
+++ b/src/csv_exporter.cpp
@@ -60,11 +60,18 @@ ExportCSV(const std::wstring& wstrCSVFilePath, const std::vector<S7DeviceSymbolI
         return CS7PError(L"CreateFileW failed with error " + std::to_wstring(GetLastError()));
     }
 
-    // Write the CSV output.
+    // Write the BOM to indicate UTF-8 output.
+    const unsigned char ByteOrderMark[] = { 0xEF, 0xBB, 0xBF };
     DWORD cbWritten;
+    if (!WriteFile(hFile.get(), ByteOrderMark, sizeof(ByteOrderMark), &cbWritten, nullptr))
+    {
+        return CS7PError(L"WriteFile failed for the ByteOrderMark with error " + std::to_wstring(GetLastError()));
+    }
+
+    // Write the CSV output.
     if (!WriteFile(hFile.get(), strCSV.c_str(), strCSV.size(), &cbWritten, nullptr))
     {
-        return CS7PError(L"WriteFile failed with error " + std::to_wstring(GetLastError()));
+        return CS7PError(L"WriteFile failed for the CSV content with error " + std::to_wstring(GetLastError()));
     }
 
     return std::monostate();
diff --git a/src/version.h b/src/version.h
index 7f91aab..0e400d9 100644
--- a/src/version.h
+++ b/src/version.h
@@ -7,7 +7,7 @@
 #pragma once
 
 #define APP_MAJOR_VERSION       2
-#define APP_MINOR_VERSION       3
+#define APP_MINOR_VERSION       4
 
 
 // The following macro magic turns arbitrary preprocessor constants into strings.