PackageDeployment Module Help

Package Deployment Module

Start-Program Cmdlet

Version 2.1.0.0

Start-Program

Synopsis

Execute program

Syntax

Start-Program [-Command] <String> [[-WorkingDirectory] <String>] [[-ExitCodeVariable] <String>] [-ContinueOnError] [-SecureParameters] [-Wait] [-Wow64] [[-MaxWaitMinutes] <String>] [[-Context] <String>] [<CommonParameters>]

Description

Use this command to run a DOS or Windows program. In contrast to the Execute command, the ExecuteEx command is used to execute server-sided and local programs.The result is returned to a variable and can be used as such.
The command starts the specified program; start parameters are supported. Please always include the file name extension EXE (this is important because NetInstall must be able to recognize the parameters in long file names). (Long file names may contain blanks.)
A user must have the respective permission to execute the command.

Parameters

-Command <String>

Enter the executable file (EXE) with a path. Click the Browser icon to find the executable file you want.

Required

True

Position

0

Accepts pipeline input

False

-Context <String>

User: Execution under user account; logging in HKEY_CURRENT_USER, i.e. for the user.
UserPerService: User-related command, execution in Service context.
Computer: Execution under user account; logging in HKEY_CURRENT_MACHINE, i.e. for the computer.
ComputerPerService: Execution in service context; logging in HKEY_LOCAL_MACHINE, i.e. for the computer.

Required

False

Position

4

Accepts pipeline input

False

-ContinueOnError <SwitchParameter>

Continues script execution in spite of errors in the respective command

Required

False

Position

Named

Accepts pipeline input

False

-ExitCodeVariable <String>

#TODO#

Required

False

Position

2

Accepts pipeline input

False

-MaxWaitMinutes <String>

#TODO#

Required

False

Position

3

Accepts pipeline input

False

-SecureParameters <SwitchParameter>

The command or the variable are not written to log file. Use this option if you do not want the installation parameters or the password, for example, to be read out from the variable.

Required

False

Position

Named

Accepts pipeline input

False

-Wait <SwitchParameter>

Wait for completion of the program.

Required

False

Position

Named

Accepts pipeline input

False

-WorkingDirectory <String>

#TODO#

Required

False

Position

1

Accepts pipeline input

False

-Wow64 <SwitchParameter>

By default, the PackageDeployment module assumes to run in a 64-bit PowerShell process on 64-bit systems, and therefore defaults to the 64-bit application location (if different from the 32-bit application location) for file and registry accesses. If you want to access the 32-bit counterparts (in the file system %WinDir%\SysWOW64 instead of %WinDir%\System32, in the registry HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node instead of HKEY_LOCAL_MACHINE\SOFTWARE), use the -Wow64 switch.

Required

False

Position

Named

Accepts pipeline input

False

<CommonParameters>

For more information about common parameters, type "Get-Help about_CommonParameters".