Borra el valor de una variable.
Sintaxis
Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Descripción
El cmdlet Clear-Variable borra los datos almacenados en una variable, pero no elimina la variable. Como resultado, el nuevo valor de la variable es NULL (vacío). Si se ha especificado un tipo de objeto o dato para la variable, Clear-Variable mantiene el tipo del objeto almacenado en la variable.
Parámetros
-Exclude <string[]>
Omite los elementos especificados. El valor de este parámetro califica el parámetro Name. Escriba un patrón o un elemento del nombre, como "s*". Se permite el uso de caracteres comodín.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Force
Permite al cmdlet borrar una variable incluso si es de solo lectura. Aunque use el parámetro Force, el cmdlet no puede borrar constantes.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Include <string[]>
Borra únicamente los elementos especificados. El valor de este parámetro califica el parámetro Name. Escriba un patrón o un elemento del nombre, como "s*". Se permite el uso de caracteres comodín.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Name <string[]>
Especifica el nombre de la variable que se va a borrar. Se permite el uso de caracteres comodín. Esto parámetro es obligatorio, pero el nombre del parámetro ("Name") es opcional.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa la variable que se ha borrado. De forma predeterminada, este cmdlet no genera resultados.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Scope <string>
Especifica el ámbito en el que es válido este alias. Los valores válidos son "Global", "Local", "Script" o el número correspondiente al ámbito actual (entre 0 y el número de ámbitos, donde 0 es el ámbito actual y 1 su ámbito principal). "Local" es el valor predeterminado. Para obtener más información, vea about_Scopes.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el comando.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-WhatIf
Describe lo que ocurriría si ejecutara el comando sin ejecutarlo realmente.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
Ninguno No se pueden canalizar objetos a Clear-Variable. |
|
Salidas |
Ninguno o System.Management.Automation.PSVariable Cuando se usa el parámetro PassThru, Clear-Variable genera un objeto System.Management.Automation.PSVariable que representa la variable que se ha borrado. En caso contrario, este cmdlet no genera resultados. |
Notas
Para eliminar una variable junto con su valor, use Remove-Variable o Remove-Item.
Clear-Variable no eliminará los valores de las variables que se hayan definido como constantes o que sean propiedad del sistema, aun cuando se use el parámetro -Force.
Si la variable que se está borrando no existe, el cmdlet no surte efecto. No crea una variable con un valor nulo.
También puede hacer referencia a Clear-Variable mediante su alias integrado, "clv". Para obtener más información, vea about_Aliases.
Ejemplo 1
C:\PS>clear-variable my* -global Descripción ----------- Este comando elimina el valor de las variables globales que comienzan con "my".
Ejemplo 2
C:\PS>$a=3
C:\PS>&{ clear-variable a }
C:\PS>$a
3
Descripción
-----------
Estos comandos demuestran que cuando se borra una variable en un ámbito secundario, no se elimina su valor en el ámbito principal. El primer comando establece el valor de la variable $a en "3". El segundo comando usa el operador de invocación (&) para ejecutar un comando Clear-Variable en un nuevo ámbito. La variable se borra en el ámbito secundario (aunque no exista), pero no se borra en el ámbito local. El tercer comando, que obtiene el valor de $a, muestra que el valor "3" no resulta afectado.
Ejemplo 3
C:\PS>clear-variable -name processes Descripción ----------- Este comando borra el valor de la variable $processes. La variable $processes todavía existe, pero su valor es nulo.
Vea también