Compartir a través de

Clear-Variable

  • Referencia
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>]

Description

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 datos especificado, este cmdlet conserva el tipo del objeto almacenado en la variable.

Ejemplos

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

Clear-Variable my* -Scope Global

Este comando quita el valor de las variables globales que tienen nombres que comienzan por mi.

Ejemplo 2: Borrar una variable en un ámbito secundario, pero no el ámbito primario

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

3

Estos comandos muestran que borrar una variable en un ámbito secundario no borra el valor del ámbito primario. El primer comando establece el valor de la variable $a en 3. El segundo comando usa el operador invoke (&) para ejecutar el comando Clear-Variable en un nuevo ámbito. La variable se borra en el ámbito secundario (aunque no existe), 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 Processes. Después de que el cmdlet complete la operación, la variable denominada Procesos sigue existiendo, pero el valor es NULL.

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
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 Name. Escriba un elemento o patrón de nombre, como "s*". Se permiten caracteres comodín.

Tipo:String[]
Posición:Named
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 con el parámetro Force, el cmdlet no puede borrar constantes.

Tipo:SwitchParameter
Posición:Named
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 Name. Escriba un elemento o patrón de nombre, como "s*". Se permiten caracteres comodín.

Tipo:String[]
Posición:Named
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 caracteres comodín. 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á trabajando. De forma predeterminada, este cmdlet no genera ninguna salida.

Tipo:SwitchParameter
Posición:Named
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 usar un número relativo al ámbito actual (0 a través del número de ámbitos, donde 0 es el ámbito actual y 1 es su elemento primario). Local es el valor predeterminado. Para obtener más información, vea about_Scopes.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

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

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas

None

De forma predeterminada, este cmdlet no devuelve ninguna salida.

PSVariable

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

Notas

PowerShell incluye los siguientes alias para Clear-Variable:

  • Todas las plataformas:

    • clv

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

    Este cmdlet no elimina los valores de las variables que se establecen como constantes o que pertenecen al 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 NULL.