Wceload Tool (Compact 7)

  • Article

3/12/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 ] [ /confignotify | /nodelete | /safe | /silent | /verifyconfig] <cab file location>

Parameters

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

    Note

    If you do not specify /nodelete or /delete 0 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." This parameter is the same as /silent. The /nou parameter was retained for compatibility with Windows CE 5.0 and Windows Embedded CE 6.0 applications.
  • /confignotify
    Generates a configuration result notification that is placed in the text message store on the device.
  • /nodelete
    Tells Wceload not to remove the .cab file after installation.
  • /safe
    Tells Wceload to make sure the .cab file does not contain executable files.
  • /silent
    Tells Wceload not to prompt the user for input during the installation. By default, prompts are answered with "Yes," unless the .cab file is not signed. However, if the .cab file is unsigned, Wceload fails and displays a message stating that the failure occurred because the program being installed was not digitally signed with a trusted certificate.
  • /verifyconfig
    Tells Wceload to verify that the file passed in is a .cpf file. If the file is not a .cpf file, the installation fails.
  • 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 /nodelete "\Temp\MyCabFile.cab"

See Also

Tasks

Include Setup.dll in your .Cab File

Reference

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