Remove PSProfileVariable

Remove-PSProfileVariable

SYNOPSIS

Removes a Variable from $PSProfile.Variables.

SYNTAX

Remove-PSProfileVariable [-Scope] <String> [-Name] <String[]> [-Force] [-Save] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes a Variable from $PSProfile.Variables.

EXAMPLES

EXAMPLE 1

Remove-PSProfileVariable -Scope Environment -Name '~' -Save

Removes the Environment variable '~' from $PSProfile.Variables then saves the updated configuration.

PARAMETERS

-Scope

The scope of the Variable to remove between Environment or Global.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the Variable to remove from $PSProfile.Variables.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

If $true, also removes the variable from the current session at the specified scope.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Save

If $true, saves the updated PSProfile after updating.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS