Share via

Import-StartLayout

  • Article

Import-StartLayout

Imports the layout of the Start screen into a mounted Windows image.

Syntax

Parameter Set: LiteralPath
Import-StartLayout [-LayoutLiteralPath] <String> [-MountLiteralPath] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Path
Import-StartLayout [-LayoutPath] <String> [-MountPath] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Import-StartLayout cmdlet imports the layout of the Start screen into a mounted Windows image. When you import a layout, it replaces the existing layout of the Start screen. Before you use this cmdlet, mount the Windows image file to import the layout into.

Use the Export-StartLayout cmdlet to create a .bin file, and then use this cmdlet to import that file. You must have administrator rights to import a layout.

The Export-StartLayout cmdlet also exports layouts as .xml files, but this cmdlet imports only .bin files.

Parameters

-LayoutLiteralPath<String>

Specifies a literal path to a layout file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\), enclose the string in single quotes (').

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LayoutPath<String>

Specifies a path to a layout file.

Aliases

none

Required?

true

Position?

2

Default Value

null

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MountLiteralPath<String>

Specifies the literal path where you mounted the .wim file. This parameter does not accept the wildcard character (*). If the path includes an escape character (\), enclose the string in single quotes (').

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MountPath<String>

Specifies the path where you mounted the .wim file.

Aliases

none

Required?

true

Position?

3

Default Value

null

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Import a layout into a Windows image

This command imports a layout of the Start screen into a Windows image.

PS C:\> Import-StartLayout -LayoutPath "Layout.bin" -MountPath "E:\MountedImage\"

Example 2: Validate the layout file and Windows image

This command validates the layout file and the Windows image by using the WhatIf parameter. Besides that parameter, the command is the same as the previous example, but this command makes no changes.

PS C:\> Import-StartLayout -LayoutPath "Layout.bin" -MountPath "E:\MountedImage" -WhatIf

Export-StartLayout