GetCPInfoEx functions, winnls.h line 1568

Author: fredrikhr

src-native/THNETII.WinApi.Headers.WinNls/WinNlsFunctions.cs

@@ -238,5 +238,84 @@ public static extern bool GetCPInfo(
             out CPINFO lpCPInfo
             );
         #endregion
+        // C:\Program Files (x86)\Windows Kits\10\Include\10.0.17134.0\um\WinNls.h, line 1548
+        #region GetCPInfoExA function
+        /// <inheritdoc cref="GetCPInfoEx"/>
+        [Obsolete("Use Unicode. The information in this structure cannot represent all encodings accuratedly and may be unreliable on many machines.")]
+        [DllImport(Kernel32, CallingConvention = CallingConvention.Winapi, SetLastError = true, CharSet = CharSet.Ansi)]
+        [return: MarshalAs(UnmanagedType.Bool)]
+        public static extern bool GetCPInfoExA(
+            [In] int CodePage,
+            [In] int dwFlags,
+            out CPINFOEXA lpCPInfoEx
+            );
+        #endregion
+        // C:\Program Files (x86)\Windows Kits\10\Include\10.0.17134.0\um\WinNls.h, line 1556
+        #region GetCPInfoExW function
+        /// <inheritdoc cref="GetCPInfoEx"/>
+        [Obsolete("Use Unicode. The information in this structure cannot represent all encodings accuratedly and may be unreliable on many machines.")]
+        [DllImport(Kernel32, CallingConvention = CallingConvention.Winapi, SetLastError = true, CharSet = CharSet.Unicode)]
+        [return: MarshalAs(UnmanagedType.Bool)]
+        public static extern bool GetCPInfoExW(
+            [In] int CodePage,
+            [In] int dwFlags,
+            out CPINFOEXW lpCPInfoEx
+            );
+        #endregion
+        // C:\Program Files (x86)\Windows Kits\10\Include\10.0.17134.0\um\WinNls.h, line 1564
+        #region GetCPInfoEx function
+        /// <summary>
+        /// Retrieves information about any valid installed or available code page.
+        /// </summary>
+        /// <param name="CodePage">
+        /// Identifier for the code page for which to retrieve information. The application can specify the code page identifier for any installed or available code page, or one of the following predefined values. See <a href="https://docs.microsoft.com/windows/desktop/Intl/code-page-identifiers">Code Page Identifiers</a> for a list of identifiers for ANSI and other code pages.
+        /// <list type="table">
+        /// <listheader><term>Value</term><description>Meaning</description></listheader>
+        /// <item><term><see cref="CP_ACP"/></term><description>Use the system default Windows ANSI code page.</description></item>
+        /// <item><term><see cref="CP_MACCP"/></term><description>Use the system default Macintosh code page.</description></item>
+        /// <item><term><see cref="CP_OEMCP"/></term><description>Use the system default OEM code page.</description></item>
+        /// <item><term><see cref="CP_THREAD_ACP"/></term><description>Use the current thread's ANSI code page.</description></item>
+        /// </list>
+        /// </param>
+        /// <param name="dwFlags">Reserved; must be <c>0</c> (zero).</param>
+        /// <param name="lpCPInfoEx">A <see cref="CPINFOEX"/> structure that receives information about the code page.</param>
+        /// <returns>
+        /// Returns <see langword="true"/> if successful, or <see langword="false"/> otherwise. To get extended error information, the application can call <see cref="GetLastError"/>, which can return one of the following error codes:
+        /// <list type="table">
+        /// <item><term><see cref="ERROR_INVALID_PARAMETER"/></term><description>Any of the parameter values was invalid.</description></item>
+        /// </list>
+        /// </returns>
+        /// <remarks>
+        /// <para>The information retrieved in the <see cref="CPINFOEX"/> structure is not always useful for all code pages. To determine buffer sizes, for example, the application should call <see cref="MultiByteToWideChar"/> or <see cref="WideCharToMultiByte"/> to request an accurate buffer size. If <see cref="CPINFOEX"/> settings indicate that a lead byte exists, the conversion function does not necessarily handle lead bytes differently, for example, in the case of a missing or illegal trail byte.</para>
+        /// <para>
+        /// <list type="table">
+        /// <listheader><term>Requirements</term></listheader>
+        /// <item><term><strong>Minimum supported client:</strong></term><description>Windows 2000 Professional [desktop apps | UWP apps]</description></item>
+        /// <item><term><strong>Minimum supported server:</strong></term><description>Windows 2000 Server [desktop apps | UWP apps]</description></item>
+        /// </list>
+        /// </para>
+        /// <para>Microsoft Docs page: <a href="https://docs.microsoft.com/en-us/windows/win32/api/winnls/nf-winnls-getcpinfoexw">GetCPInfoExW function</a></para>
+        /// </remarks>
+        /// <exception cref="DllNotFoundException">The native library containg the function could not be found.</exception>
+        /// <exception cref="EntryPointNotFoundException">Unable to find the entry point for the function in the native library.</exception>
+        /// <seealso cref="CPINFOEX"/>
+        /// <seealso cref="GetACP"/>
+        /// <seealso cref="GetCPInfo"/>
+        /// <seealso cref="GetOEMCP"/>
+        /// <seealso href="https://docs.microsoft.com/windows/desktop/Intl/national-language-support">National Language Support</seealso>
+        /// <seealso href="https://docs.microsoft.com/windows/desktop/Intl/national-language-support-functions">National Language Support Functions</seealso>
+        [Obsolete("Use Unicode. The information in this structure cannot represent all encodings accuratedly and may be unreliable on many machines.")]
+        [DllImport(Kernel32, CallingConvention = CallingConvention.Winapi, SetLastError = true
+#if !NETSTANDARD1_3
+        , CharSet = CharSet.Auto 
+#endif
+            )]
+        [return: MarshalAs(UnmanagedType.Bool)]
+        public static extern bool GetCPInfoEx(
+            [In] int CodePage,
+            [In] int dwFlags,
+            out CPINFOEX lpCPInfoEx
+            );
+        #endregion
     }
 }

test/THNETII.WinApi.Native.Test/THNETII.WinApi.Native.Test.csproj

@@ -23,6 +23,9 @@
   <ItemGroup>
     <ProjectReference Include="..\..\src-native\THNETII.WinApi.Constants.SCardErr\THNETII.WinApi.Constants.SCardErr.csproj" />
     <ProjectReference Include="..\..\src-native\THNETII.WinApi.Constants.WinError\THNETII.WinApi.Constants.WinError.csproj" />
+    <ProjectReference Include="..\..\src-native\THNETII.WinApi.Constants.WinNls\THNETII.WinApi.Constants.WinNls.csproj">
+      <PrivateAssets>All</PrivateAssets>
+    </ProjectReference>
     <ProjectReference Include="..\..\src-native\THNETII.WinApi.Headers.ErrHandlingApi\THNETII.WinApi.Headers.ErrHandlingApi.csproj" />
     <ProjectReference Include="..\..\src-native\THNETII.WinApi.Headers.MinWinBase\THNETII.WinApi.Headers.MinWinBase.csproj" />
     <ProjectReference Include="..\..\src-native\THNETII.WinApi.Headers.MinWinDef\THNETII.WinApi.Headers.MinWinDef.csproj" />

test/THNETII.WinApi.Native.Test/WinNls.Test/GetCPInfo.cs

@@ -7,11 +7,16 @@
 
 namespace THNETII.WinApi.Native.WinNls.Test
 {
+    using static WinNlsConstants;
     using static WinNlsFunctions;
 
     public static class GetCPInfo
     {
         [TheoryWindowsOS]
+        [InlineData(CP_ACP)]
+        [InlineData(CP_MACCP)]
+        [InlineData(CP_OEMCP)]
+        [InlineData(CP_THREAD_ACP)]
         [InlineData(437)]   //  IBM437          OEM United States
         [InlineData(850)]   //  ibm850          OEM Multilingual Latin 1; Western European (DOS)
         [InlineData(1250)]  //  windows-1250    ANSI Central European; Central European (Windows)

test/THNETII.WinApi.Native.Test/WinNls.Test/GetCPInfoEx.cs

@@ -0,0 +1,110 @@
+using System;
+using System.ComponentModel;
+using System.Runtime.InteropServices;
+
+using Xunit;
+
+namespace THNETII.WinApi.Native.WinNls.Test
+{
+    using static WinNlsConstants;
+    using static WinNlsFunctions;
+
+    public static class GetCPInfoEx
+    {
+        [TheoryWindowsOS]
+        [InlineData(CP_ACP)]
+        [InlineData(CP_MACCP)]
+        [InlineData(CP_OEMCP)]
+        [InlineData(CP_THREAD_ACP)]
+        [InlineData(437)]   //  IBM437          OEM United States
+        [InlineData(850)]   //  ibm850          OEM Multilingual Latin 1; Western European (DOS)
+        [InlineData(1250)]  //  windows-1250    ANSI Central European; Central European (Windows)
+        [InlineData(1252)]  //  windows-1252    ANSI Latin 1; Western European (Windows)
+        [InlineData(20127)] //  us-ascii        US-ASCII (7-bit)
+        [InlineData(28591)] //  iso-8859-1      ISO 8859-1 Latin 1; Western European (ISO)
+        [InlineData(28605)] //  iso-8859-15     ISO 8859-15 Latin 9
+        [InlineData(65001)] //  utf-8           Unicode (UTF-8)
+        [Obsolete("Deprecated Win API")]
+        public static void ReturnsTrueForCodePageAnsi(int codepage)
+        {
+            bool success = GetCPInfoExA(codepage, default, out var cpinfo);
+
+            if (!success)
+                throw new Win32Exception(Marshal.GetLastWin32Error());
+
+            Assert.True(success);
+
+            _ = cpinfo.MaxCharSize;
+            foreach (ref readonly byte defaultByte in cpinfo.DefaultChar)
+                _ = defaultByte;
+            foreach (ref readonly byte leadByte in cpinfo.LeadByte)
+                _ = leadByte;
+            _ = cpinfo.UnicodeDefaultChar;
+            _ = cpinfo.CodePageName;
+        }
+
+        [TheoryWindowsOS]
+        [InlineData(CP_ACP)]
+        [InlineData(CP_MACCP)]
+        [InlineData(CP_OEMCP)]
+        [InlineData(CP_THREAD_ACP)]
+        [InlineData(437)]   //  IBM437          OEM United States
+        [InlineData(850)]   //  ibm850          OEM Multilingual Latin 1; Western European (DOS)
+        [InlineData(1250)]  //  windows-1250    ANSI Central European; Central European (Windows)
+        [InlineData(1252)]  //  windows-1252    ANSI Latin 1; Western European (Windows)
+        [InlineData(20127)] //  us-ascii        US-ASCII (7-bit)
+        [InlineData(28591)] //  iso-8859-1      ISO 8859-1 Latin 1; Western European (ISO)
+        [InlineData(28605)] //  iso-8859-15     ISO 8859-15 Latin 9
+        [InlineData(65001)] //  utf-8           Unicode (UTF-8)
+        [Obsolete("Deprecated Win API")]
+        public static void ReturnsTrueForCodePageUnicode(int codepage)
+        {
+            bool success = GetCPInfoExW(codepage, default, out var cpinfo);
+
+            if (!success)
+                throw new Win32Exception(Marshal.GetLastWin32Error());
+
+            Assert.True(success);
+
+            _ = cpinfo.MaxCharSize;
+            foreach (ref readonly byte defaultByte in cpinfo.DefaultChar)
+                _ = defaultByte;
+            foreach (ref readonly byte leadByte in cpinfo.LeadByte)
+                _ = leadByte;
+            _ = cpinfo.UnicodeDefaultChar;
+            _ = cpinfo.CodePageName;
+        }
+
+        [TheoryWindowsOS]
+        [InlineData(CP_ACP)]
+        [InlineData(CP_MACCP)]
+        [InlineData(CP_OEMCP)]
+        [InlineData(CP_THREAD_ACP)]
+        [InlineData(437)]   //  IBM437          OEM United States
+        [InlineData(850)]   //  ibm850          OEM Multilingual Latin 1; Western European (DOS)
+        [InlineData(1250)]  //  windows-1250    ANSI Central European; Central European (Windows)
+        [InlineData(1252)]  //  windows-1252    ANSI Latin 1; Western European (Windows)
+        [InlineData(20127)] //  us-ascii        US-ASCII (7-bit)
+        [InlineData(28591)] //  iso-8859-1      ISO 8859-1 Latin 1; Western European (ISO)
+        [InlineData(28605)] //  iso-8859-15     ISO 8859-15 Latin 9
+        [InlineData(65001)] //  utf-8           Unicode (UTF-8)
+        [Obsolete("Deprecated Win API")]
+        public static void ReturnsTrueForCodePageAuto(int codepage)
+        {
+            bool success = GetCPInfoEx(codepage, default, out var cpinfo);
+
+            if (!success)
+                throw new Win32Exception(Marshal.GetLastWin32Error());
+
+            Assert.True(success);
+
+            _ = cpinfo.MaxCharSize;
+            foreach (ref readonly byte defaultByte in cpinfo.DefaultChar)
+                _ = defaultByte;
+            foreach (ref readonly byte leadByte in cpinfo.LeadByte)
+                _ = leadByte;
+            _ = cpinfo.UnicodeDefaultChar;
+            _ = cpinfo.CodePageName;
+        }
+    }
+}