WillShowUI (Standard 8 Module Reference)
7/8/2014
Review the applicable Embedded Core modules and any examples for the WillShowUI setting in Windows Embedded 8 Standard (Standard 8).
This setting specifies when to display Windows Embedded 8 Standard (Standard 8) Setup UI pages.
Do not create an empty value for this setting.
The following table shows the possible values.
Value |
Description |
---|---|
Always |
Specifies that the Setup UI is always displayed and that all disk configurations be done manually. |
OnError |
Specifies that the Setup UI is displayed only if an error occurs, including catastrophic, non-recoverable errors. |
Never |
Specifies that the Setup UI is never displayed. |
Even if the Setup UI is set to not display, an error message might be displayed if a critical error occurs. To avoid displaying the error message, you can use the ErrorHandler.cmd file to automatically run a script to handle the error.
Modules
The following table shows the modules that you can apply this setting to. In Image Configuration Editor (ICE), you can follow the corresponding path to set this setting for a module.
Module |
Path |
Setting Description |
---|---|---|
Products/Embedded Core/International-Core-WinPE/SetupUILanguage/WillShowUI |
Deprecated. Do not use. |
|
Products/Embedded Core/Setup/DiskConfiguration/WillShowUI |
Specifies whether to show the user interface (UI) for this item. You can specify that all disk configurations be done manually by setting only WillShowUI to Always. Specifies in what circumstances to display the Setup UI for disk configuration. Because settings in DiskConfiguration are processed before the Setup UI is displayed, you can set this value to OnError and determine the success or failure of the disk configuration by whether or not the Setup UI displays. |
|
Products/Embedded Core/Setup/ImageInstall/OSImage/WillShowUI |
Specifies in what circumstances to display the Setup UI for image installation. |
|
Products/Embedded Core/Setup/UserData/ProductKey/WillShowUI |
Specifies in what circumstances the system displays the Setup UI when applying a product key specified by ProductKey. |
|
Products/Embedded Core/Setup/WindowsDeploymentServices/ImageSelection/WillShowUI |
Specifies in what circumstances to display the Setup UI for Image Selection. |
|
Products/Embedded Core/Setup/WindowsDeploymentServices/Login/WillShowUI |
Specifies in what circumstances to display the Setup UI for Windows Deployment Services login. |
XML Example
The following XML examples show how to configure the WillShowUI setting in different modules.
Disk Configuration
The following XML example shows how to configure the device such that Setup displays the disk configuration UI if it detects an error with the partition structure.
<DiskConfiguration>
<WillShowUI>OnError</WillShowUI>
</DiskConfiguration>
For an XML example of disk configuration, see Disk Configuration XML Example, System with Two Hard Drives XML Example, and Extending a Partition XML Example.
For more XML examples and recommended partition configurations, see How to Configure UEFI/GPT-Based Hard Disk Partitions, or How to Configure BIOS/MBR-Based Hard Disk Partitions.
DynamicUpdate
The following XML example shows how to enable dynamic updates during Windows Embedded 8 Standard (Standard 8) Setup and never display the UI.
<DynamicUpdate>
<Enable>true</Enable>
<WillShowUI>Never</WillShowUI>
</DynamicUpdate>
User Data Product Key
For an example that shows how to set user data, see User Data XML Example.
Windows Deployment Services Image Selection
The following example shows how to display the UI if an error occurs.
<OSImage>
<WillShowUI>OnError</WillShowUI>
</OSImage>
Windows Deployment Services Login
The following example shows how to display the Setup UI if an error occurs.
<WindowsDeploymentServices>
<Login>
<WillShowUI>OnError</WillShowUI>
<Credentials>
<Username>Administrator</Username>
<Domain>MY-DOMAIN-NAME</Domain>
<Password>********</Password>
</Credentials>
</Login>
</WindowsDeploymentServices>
For an example of a complete Windows Deployment Services deployment, see Complete Windows Deployment Services deployment XML Example.
OS Image Installation
The following XML example shows how to display the Setup UI for ImageSelection if an error occurs.
<OSImage>
<WillShowUI>OnError</WillShowUI>
</OSImage>
For an XML example that shows how to set the ImageInstall setting to install both an OS image and a data image, see Setting the ImageInstall Setting XML Example.