Share via

Wceload Tool (Compact 2013)

  • Article

3/26/2014

This command launches application installations by using a cabinet (.cab) or CAB provisioning file (.cpf) file.

Syntax

wceload.exe [ /noaskdest | /askdest] [ /delete <number> | /noui ] [/pid] [/pbar] <cab file location>

Parameters

  • /noaskdest
    Specifies that the user is not prompted for the installation directory. If this parameter is used, other parameters such as the .cab file path are ignored, and the default directory specified in the DefaultInstall section of the .inf file is used.
  • /askdest
    Specifies that the user is prompted for the installation directory.

  • /delete*<number>*
    Determines how Wceload removes the .cab file after installation.

    Note

    If you do not specify /delete0 when you run Wceload, the .cab file is deleted, even if the installation is not successful.

    Value

    Description

    0

    Does not remove the .cab file after the contents are installed.

    1

    Default value. Removes the .cab file after the contents are installed.

    2

    Treats the .cab file as discrete blocks of data, and dynamically deletes them.

    This setting is useful when the .cab file uses most of the available RAM on the device because it unpacks and installs data blocks of the .cab file in the unused RAM.

    The blocks are read and installed on the device in last-to-first order, the opposite of the file order in the .cab file. After unpacking and installation of each block into the device file system, the block is then deleted from the .cab file to free RAM.
  • /noui
    Tells Wceload not to prompt the user for input during the installation. By default, prompts are answered with "Yes."

  • /pid
    Associates a package id with each cab file. The package id is included in the set of registry entries created for the cab file (entries are also written for the cab name, destination, etc.). Place the package id after the cab file name in the command. Here is an example in which the package id is 12345:

    wceload /pid test.cab 12345
  • /pbar
    Displays a progress bar when a cab file is being installed.
  • cab file location
    Tells Wceload the location of the .cab file to install.

Remarks

Use cabinet (.cab) files to package files for delivery and installation. A .cpf file is a provisioning file that you wrap in a .cab file. For information about how to create .cab files, see CAB Wizard.

Wceload runs on a device. Use Wceload to install a cabinet file (.cab) to a specified location on a device. You can configure .cab files to let a user select where to install the .cab file or you can suppress the selection prompt and install the .cab file to a default location. Set the default install location in the information file (.inf) that is used to create the .cab file.

Typically, you run the Wceload command directly to install .cab files. Alternatively, other programs can execute wceload.exe. For example, if you use File Explorer on your device to view and open a .cab file, the shell automatically runs Wceload to install the .cab file.

By default, an unload file is generated during installation using Wceload. The unload file name has the following format:

<Software Provider Name><Program Name>

For more information, see Unload Tool.

Example

The following code example illustrates how to use Wceload.

wceload "\Temp\MyCabFile.cab"

See Also

Reference

Platform Builder Command Line Tools
Unload Tool
Wceldcmd Tool
CAB Wizard
Information (.inf) File Overview