Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

GetUserPreferredUILanguages (kernel32)
 
.
Summary
Retrieves information about the user preferred UI languages.

C# Signature:

[DllImport("Kernel32.dll", CharSet = CharSet.Auto, SetLastError = true)]
static extern bool GetUserPreferredUILanguages(
   uint dwFlags,
   out uint pulNumLanguages,
   char[] pwszLanguagesBuffer,
   StringBuilder pwszLanguagesBuffer,
   ref uint pcchLanguagesBuffer);

VB Signature:

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

Tips & Tricks:

The char[] is used because StringBuilder would otherwise stop at the first \0 character, resulting in only one language ever being reported.

A possibly better type for pwszLanguagesBuffer is Char[] because StringBuilder will end at the first \0 character; which the native API uses as the delimiter for the array elements it returns.

Sample Code:

static void DisplayUserPref()
{
    StringBuilder languagesBuffer = new StringBuilder();
    uint languagesCount, languagesBufferSize = 0;

    if (GetUserPreferredUILanguages(
        MUI_LANGUAGE_NAME,
        out languagesCount,
        null,
        ref languagesBufferSize))
    {
        char[] languagesBuffer = new char[languagesBufferSize];
        languagesBuffer.EnsureCapacity((int)languagesBufferSize);
        if (GetUserPreferredUILanguages(
            MUI_LANGUAGE_NAME,
            out languagesCount,
            languagesBuffer,
            ref languagesBufferSize))
        {
            string[] languages = new string(languagesBuffer, 0, (int) languagesBufferSize - 2).Split('\0');
            string[] languages = languagesBuffer.ToString().Split(new char[] { '\0' });
            Console.WriteLine("GetUserPreferredUILanguages returns " + languages.Length + " languages:");
            foreach (string language in languages)
                Console.WriteLine("   " + language);
        }
        else
            Console.WriteLine("GetUserPreferredUILanguages(2) returns #" + Marshal.GetLastWin32Error());
    }
    else
        Console.WriteLine("GetUserPreferredUILanguages(1) returns #" + Marshal.GetLastWin32Error());
}

const uint MUI_LANGUAGE_ID = 0x4;    // Use traditional language ID convention
const uint MUI_LANGUAGE_NAME = 0x8;    // Use ISO language (culture) name convention

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions