SetKeyboardLanguage
- Last UpdatedOct 29, 2026
- 2 minute read
SetKeyboardLanguage sets the language of any Virtual Keyboards displayed in the Viewer.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
SetKeyboardLanguage |
System Info |
Synchronous |
No |
Supported |
Supported |
Supported |
Supported |
Supported |
Syntax
SetKeyboardLanguage(strLanguage)
strLanguage
The two-letter code for the language to be set. The currently available options include:
|
Code |
Language |
|---|---|
|
EN |
English (default) |
|
GE |
German |
|
FR |
French |
|
CH |
Chinese |
|
JA |
Japanese |
You can also specify other codes for additional languages. see Notes below.
Return value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Success |
|
1 |
Error |
Notes
This function is supported only on Windows-based client stations that use the Viewer program to display project screens. That includes:
-
The local Viewer that is part of the project runtime for Windows
-
The standalone Secure Viewer program for Windows
-
The Web Thin Client add-on (also known as ISSymbol) for Internet Explorer
It does not include any version of Mobile Access, which uses a different technology to display project screens in web browsers.
When this function is executed, it causes the Viewer program to load an initialization file that is located in the program folder. Each language code that you can specify for the strLanguage parameter should have a corresponding VK initialization file (VK<language code>.ini), and that file contains the key definitions for the language. For example, VKEN.ini contains the key definitions for English, VKFR.ini contains the key definitions for French, and so on.
You can modify the existing VK initialization files in order to customize the key definitions, and you can also create new files for additional languages as long as they have their own unique codes (for example, VKES.ini for Spanish). For more information about how to create or modify the files, contact your software distributor.
Please note that if you create or modify any VK initialization files, you must distribute the new files to all client stations and make sure they are copied to the correct location in the program folder. (In other words, they must be in the same folder that contains Viewer.exe.) The changes cannot be automatically disseminated by the project runtime.
Examples
Set the Virtual Keyboard language to French:
SetKeyboardLanguage("FR")
Set the Virtual Keyboard language according to the current value of tagLanguage:
SetKeyboardLanguage(tagLanguage)