Clear-Variable

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

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, this cmdlet preserves the type of the object stored in the variable.

Clear-Variable my* -Scope Global

This command removes the value of global variables that have names that begin with my.

$a = 3
&{ Clear-Variable a }
$a

3

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

Clear-Variable -Name "Processes"

This command deletes the value of the variable named Processes. After the cmdlet completes the operation, the variable named Processes still exists, but the value is null.

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

You can't pipe objects to this cmdlet.

By default, this cmdlet returns no output.

When you use the PassThru parameter, this cmdlet returns a PSVariable object representing the cleared variable.

PowerShell includes the following aliases for Clear-Variable:

• All platforms:

  • clv

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

  This cmdlet does 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.