PackageDeployment Module Help

Package Deployment Module

Write-RegistryValue Cmdlet

Version 2.1.0.0

Write-RegistryValue

Synopsis

Change REG_SZ or REG_EXPAND_SZ Value in Registry

Syntax

Write-RegistryValue [-KeyPath] <String> [[-ValueName] <String>] [[-Value] <String>] [-AllowDuplicates] [-ContinueOnError] [-Wow64] [[-ValueKind] <RegistryValueKind>] [[-Action] <String>] [[-Context] <String>] [<CommonParameters>]

Description

Changes or extends a registry String value; updates existing registry entries.
If an error occurs while running the command, the script stops. If you want to continue the script if there is an error, enable the setting Continue script despite error in the Script Editor.

Parameters

-Action <String>

Set: Replace extisting value.
Remove: Delete value from existing line.
Append: Add Value to end of existing line.
Prepend: Insert value at beginning of the existin line

Required

False

Position

4

Accepts pipeline input

False

-AllowDuplicates <SwitchParameter>

Value will be added or inserted even if it already exists in the line.

Required

False

Position

Named

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

5

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

-KeyPath <String>

Specify the registry key (branch) you want to change.

Required

True

Position

0

Accepts pipeline input

False

-Value <String>

Enter the value. The details of the value (replace, add, insert or delete) can be specified under Action

Required

False

Position

2

Accepts pipeline input

False

-ValueKind <RegistryValueKind>

ExpandString: Stores the value as REG_EXPAND_SZ value in the registry.
Binary: Binary value.

Required

False

Position

3

Accepts pipeline input

False

-ValueName <String>

Either the default value of the key or the name of a different value. If this is present on the workstation, it can be selected.

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".