Clear-Variable (Microsoft.PowerShell.Utility)

Clear-Variable

Módulo:

Microsoft.PowerShell.Utility

Elimina el valor de una variable.

Sintaxis

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

Descripción

El cmdlet Clear-Variable elimina los datos almacenados en una variable, pero no elimina la variable. Como resultado, el valor de la variable es NULL (vacío). Si la variable tiene un tipo de objeto o de datos especificado, este cmdlet conserva el tipo del objeto almacenado en la variable.

Ejemplos

Ejemplo 1: eliminar el valor de las variables globales que comienzan con una cadena de búsqueda

Clear-Variable my* -Scope Global

Este comando elimina el valor de las variables globales que tienen nombres que comienzan con my.

Ejemplo 2: borrar una variable en un ámbito secundario pero no en el ámbito principal

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

3

Estos comandos demuestran que borrar una variable en un ámbito secundario no borra el valor en el ámbito principal. El primer comando establece el valor de la variable $a en 3. El segundo comando utiliza el operador de invocación (&) para ejecutar Clear-Variable comando en un nuevo alcance. La variable se borra en el ámbito secundario (aunque no existía), pero no se borra en el ámbito local. El tercer comando, que obtiene el valor de $a, muestra que el valor 3 no se ve afectado.

Ejemplo 3: eliminar el valor de la variable especificada

Clear-Variable -Name "Processes"

Este comando elimina el valor de la variable denominada Procesos. Una vez que el cmdlet completa la operación, la variable denominada Procesos todavía existe, pero el valor es nulo.

Parámetros

-Confirm

Le solicita confirmación antes de ejecutar el cmdlet.

Tipo :

SwitchParameter

Alias:

cf

Posición:

Nombrado

Valor predeterminado:

False

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-Exclude

Especifica una matriz de elementos que este cmdlet omite en la operación. El valor de este parámetro califica el parámetro Nombre. Introduzca un elemento de nombre o patrón, como "s*". Se permiten comodines.

Tipo :

String[]

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

True

-Force

Permite que el cmdlet borre una variable incluso si es de solo lectura. Incluso utilizando el parámetro Force, el cmdlet no puede borrar las constantes.

Tipo :

SwitchParameter

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-Include

Especifica una matriz de elementos que este cmdlet incluye en la operación. El valor de este parámetro califica el parámetro Nombre. Introduzca un elemento de nombre o patrón, como "s*". Se permiten comodines.

Tipo :

String[]

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

True

-Name

Especifica el nombre de la variable que se va a borrar. Se permiten comodines. Este parámetro es obligatorio, pero el nombre del parámetro Nombre es opcional.

Tipo :

String[]

Posición:

0

Valor predeterminado:

None

Requerido:

True

Aceptar entrada de canalización:

True

Aceptar caracteres comodín:

True

-PassThru

Devuelve un objeto que representa el elemento con el que estás trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

Tipo :

SwitchParameter

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-Scope

Especifica el ámbito en el que este alias es válido.

Los valores aceptables para este parámetro son:

Global

Local

Script

También puede utilizar un número relativo al ámbito actual (de 0 al número de ámbitos, donde 0 es el ámbito actual y 1 es su padre). Local es el valor predeterminado. Para obtener más información, consulte about_Scopes.

Tipo :

String

Posición:

Nombrado

Valor predeterminado:

None

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

-WhatIf

Muestra lo que sucedería si se ejecuta el cmdlet. El cmdlet no se ejecuta.

Tipo :

SwitchParameter

Alias:

wi

Posición:

Nombrado

Valor predeterminado:

False

Requerido:

False

Aceptar entrada de canalización:

False

Aceptar caracteres comodín:

False

Entradas

Ninguno

No puede canalizar objetos a este cmdlet.

Salidas

Ninguno

De forma predeterminada, este cmdlet no devuelve ningún resultado.

PSVariable

Cuando se utiliza el parámetro PassThru, este cmdlet devuelve un objeto PSVariable que representa la variable borrada.

Notas

PowerShell incluye los siguientes alias para Clear-Variable:

• Todas las plataformas:

  clv

• Para eliminar una variable, junto con su valor, utilice Remove-Variable o Remove-Item.

  Este cmdlet no elimina los valores de las variables establecidas como constantes o propiedad del sistema, incluso si usa el parámetro Force.

  Si la variable que está borrando no existe, el cmdlet no tiene ningún efecto. No crea una variable con un valor nulo.