powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Variable



NAME
Remove-Variable

SYNOPSIS
Deletes a variable and its value.

SYNTAX
Remove-Variable [-Name] [-Exclude ] [-Force] [-Include ] [-Scope ] [-Confirm
] [-WhatIf] []


DESCRIPTION
The Remove-Variable cmdlet deletes a variable and its value from the scope in which it is defined, such as the curr
ent session. You cannot use this cmdlet to delete variables that are set as constants or those that are owned by th
e system.


PARAMETERS
-Exclude
Omits the specified items. The value of this parameter qualifies the Name parameter. Enter a name element or pa
ttern, such as "s*". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Force []
Allows the cmdlet to remove a variable even if it is read-only. Even using the Force parameter, the cmdlet cann
ot remove a constant.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Include
Deletes only the specified items. The value of this parameter qualifies the Name parameter. Enter a name elemen
t or pattern, such as "s*". Wildcards are permitted.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Name
Specifies the name of the variable to be removed. The parameter name ("Name") is optional.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Scope
Specifies the scope in which this alias is valid. Valid values are "Global", "Local", or "Script", or a number
relative to the current scope (0 through the number of scopes, where 0 is the current scope and 1 is its parent
). "Local" is the default. For more information, see about_Scopes.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.PSVariable
You can pipe a variable object to Remove-Variable.


OUTPUTS
None
This cmdlet does not return any output.


NOTES


Changes affect only the current scope, such as a session. To delete a variable from all sessions, add a Remove-
Variable command to your Windows PowerShell profile.

You can also refer to RemoveVariable by its built-in alias, "rv". For more information, see about_Aliases.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>remove-variable Smp


Description
-----------
This command deletes the $Smp variable.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113380
Set-Variable
Get-Variable
Clear-Variable
New-Variable
about_Profiles