WillShowUI

WillShowUI specifies in what circumstances to display the user interface (UI) for disk configuration. Settings in DiskConfiguration are processed before the UI is displayed, but setting this value to Always or OnError gives notification of success or failure.

Values

Always

Specifies that the UI is always displayed.

OnError

Specifies that the UI is displayed only if an error occurs. This is the default value.

Never

Specifies that the UI is never displayed.

WillShowUI only prevents Windows Setup UI pages from being displayed. If a critical error occurs, an error message might be displayed. To avoid displaying the error message, you can use the ErrorHandler.cmd file to automatically run a script to handle the error. For more information about ErrorHandler.cmd, see Add a custom script to Windows Setup.

Valid Configuration Passes

windowsPE

Parent Hierarchy

microsoft-windows-setup- | DiskConfiguration | WillShowUI

Applies To

For the list of the supported Windows editions and architectures that this component supports, see microsoft-windows-setup-.

XML Example

The following XML output for the DiskConfiguration setting shows how to modify an existing partition structure. By default, Windows Setup will apply the partition structure, if it is possible. If Windows Setup detects an error with the partition structure, Windows Setup will display the disk configuration UI.

<DiskConfiguration>

  <WillShowUI>OnError</WillShowUI> 

  <Disk wcm:action="add">
    <DiskID>0</DiskID> 
    <WillWipeDisk>false</WillWipeDisk> 

    <ModifyPartitions>
      <!-- System partition -->
      <ModifyPartition wcm:action="add">
        <Order>1</Order> 
        <PartitionID>1</PartitionID> 
        <Label>System</Label> 
        <Format>NTFS</Format> 
        <Active>true</Active> 
      </ModifyPartition>

      <!-- Windows partition -->
      <ModifyPartition wcm:action="add">
        <Order>2</Order> 
        <PartitionID>2</PartitionID> 
        <Label>Windows</Label> 
        <Letter>C</Letter> 
        <Format>NTFS</Format> 
      </ModifyPartition>
    </ModifyPartitions>
  </Disk>


</DiskConfiguration>


<ImageInstall>
  <OSImage>
    <InstallTo>
      <DiskID>0</DiskID> 
      <PartitionID>2</PartitionID> 
    </InstallTo>
  </OSImage>
</ImageInstall>

For full 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.

DiskConfiguration