Share via

Export-StartLayout

  • Article

Export-StartLayout

Exports the layout of the Start screen.

Syntax

Parameter Set: Literal
Export-StartLayout [-LiteralPath] <String> [[-As] <AsFileType> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Non-literal
Export-StartLayout [-Path] <String> [[-As] <AsFileType> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Export-StartLayout cmdlet exports the layout of the Start screen of the current user. You can export layout as an .xml file to verify the layout, or you can export layout as a .bin file to modify the layout of an existing Windows image. Specify the appropriate file name extension, .bin or .xml, in the name of the file. To modify the layout of a Windows image, export the layout as a .bin file, and then import it into a Windows image by using the Import-StartLayout cmdlet.

Parameters

-As<AsFileType>

Specifies a file type to export. The acceptable values for this parameter are:

-- BIN. Export as a .bin file.
-- XML. Export as an .xml file.

The default value is BIN.

Aliases

none

Required?

false

Position?

2

Default Value

BIN

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LiteralPath<String>

Specifies a literal path to a layout file. Include the file name extension, .bin or .xml. 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

-Path<String>

Specifies an absolute path to a layout file. Include the file name extension, .bin or .xml.

Aliases

none

Required?

true

Position?

2

Default Value

Current Location

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.

  • Enum

    You can specify the following file formats:

    -- BIN. Export as a .bin file.
    -- XML. Export as an .xml file.

Outputs

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

Examples

Example 1: Export the layout as a .bin file

This command exports the layout of the Start screen to a file named Marketing.bin in the C:\Layouts folder. The command specifies a value of BIN for the As parameter, so the cmdlet creates a .bin file.

PS C:\> Export-StartLayout -Path "C:\Layouts\Marketing.bin" -As BIN

Import-StartLayout