Clear-Variable - PowerShell


 

Deletes the value of a variable. (Clear-Variable)

   

# NAME
Clear-Variable

# SYNOPSIS
Deletes the value of a variable.

# SYNTAX
Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

# DESCRIPTION
The Clear-Variable cmdlet deletes the data stored in a variable, but it does not delete the variable. As a result, the value of the variable is NULL (empty). If the variable has a specified data or object type, Clear-Variable preserves the type of the object stored in the variable.

# PARAMETERS
-Exclude <string[]>
Omits the specified items. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as "s*". Wildcards are permitted.

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

-Force [<SwitchParameter>]
Allows the cmdlet to clear a variable even if it is read-only. Even using the Force parameter, the cmdlet cannot clear constants.

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

-Include <string[]>
Clears only the specified items. The value of this parameter qualifies the Name parameter. Enter a name element or pattern, such as "s*". Wildcards are permitted.

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

-Name <string[]>
Specifies the name of the variable to be cleared. Wildcards are permitted. This parameter is required, but the parameter name ("Name") is optional.

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

-PassThru [<SwitchParameter>]
Returns an object representing the cleared variable. By default, this cmdlet does not generate any output.

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

-Scope <string>
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 [<SwitchParameter>]
Prompts you for confirmation before executing the command.

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

-WhatIf [<SwitchParameter>]
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

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

# INPUTS
None
You cannot pipe objects to Clear-Variable.

# OUTPUTS
None or System.Management.Automation.PSVariable
When you use the PassThru parameter, Clear-Variable generates a System.Management.Automation.PSVariable object representing the cleared variable. Otherwise, this cmdlet does not generate any output.

# NOTES

To delete a variable, along with its value, use Remove-Variable or Remove-Item.

Clear-Variable will not delete the values of variables that are set as constants or owned by the system, even if you use the -Force parameter.

If the variable that you are clearing does not exist, the cmdlet has no effect. It does not create a variable with a null value.

You can also refer to Clear-Variable by its built-in alias, "clv". For more information, see about_Aliases.

# EXAMPLE 1

C:\PS>clear-variable my* -global

# Description
-----------
This command deletes the value of the global variables that begin with "my".

# EXAMPLE 2

C:\PS>$a=3

C:\PS>&{ clear-variable a }

C:\PS>$a
3

# Description
-----------
These commands demonstrate that clearing a variable in a child scope does not clear the value in the parent scope. The first command sets the value of the variable $a to "3". The second command uses the invoke operator (&) to run a Clear-Variable command in a new scope. The variable is cleared in the child scope (although it did not exist), but it is not cleared in the local scope. The third command, which gets the value of $a, shows that the value "3" is unaffected.

# EXAMPLE 3

C:\PS>clear-variable -name processes

# Description
-----------
This command deletes the value of the $processes variable. The $processes variable still exists, but the value is null.

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

C:\Windows>powershell get-help Export-Clixml -full

ColorConsole [Version 1.7.1000] PowerShell 2.0-Export
Microsoft Windows [Version 6.1.7600]
Copyright (c) 2014 Microsoft Corporation.

OS: Windows 10, 8.1, 8, 7, Vista / Windows Server 2016, 2012, 2008
»»»» ColorConsole








Windows-10





Windows-10

... facebook.de
... Windows-10 FAQ
... Windows-10 Info


Become a Sponsor
... Your button here?





PowerShell: Deletes the value of a variable.

HTTP: ... PS_Windows/en/Clear-Variable.htm
0.25
10020

Windows BIN to ISO Converter Software for free 10, 8.1, 7.0 and MS Server Systems!

 /

Use Internet Explorer 10 or 11 as the default browser in Windows 8, 8.1 and 10 (define)!

 /

What does restore the clipboard in Multi Clipboard slots on Windows 10 (8.1, 7)?

 /

Open and start Internet Explorer always on Windows 8.1 / 10 desktop (disable Metro App)!

 /

Hide mouse cursor in DesktopOK!

 /

Lines and squares in the directory tree instead of triangles!

 /

Das automatische Ausschalten vom Bildschirm anpassen?

 /

Hibernation settings windows 10 (turn off, enable)?

 /

New folder hotkey in Windows 7 for Windows Explorer!

 /

WhatsApp lässt sich nicht aktualisieren, zu wenig Speicher!

 /

Desktop Pointer Stick as an Blue Office Clamp for Windows!

 /

Is it possible with slmgr -rearm to extend the Windows 10 trial period?

 /