Elimina el contenido de un elemento, pero no elimina el elemento.
Sintaxis
Clear-Item [-LiteralPath] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>] Clear-Item [-Path] <string[]> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Descripción
El cmdlet Clear-Item elimina el valor de un elemento, pero no elimina el elemento en sí. Por ejemplo, Clear-Item puede eliminar el valor de una variable, pero no elimina la variable. El valor que se usa para representar un elemento borrado lo define cada proveedor de Windows PowerShell. Clear-Item es similar a Clear-Content, pero se aplica a variables y alias, en lugar de a archivos.
Parámetros
-Credential <PSCredential>
Especifica una cuenta de usuario con permiso para realizar esta acción. El valor predeterminado es el usuario actual.
Escriba un nombre de usuario, como "Usuario01" o "Dominio01\Usuario01", o bien, escriba un objeto PSCredential, como uno generado por el cmdlet Get-Credential. Si escribe un nombre de usuario se le pedirá una contraseña.
Este parámetro no es compatible con los proveedores que se instalan con Windows PowerShell.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-Exclude <string[]>
Omite los elementos especificados. El valor de este parámetro califica el parámetro Path. Escriba un patrón o un elemento de la ruta de acceso, como "*.txt". Se permite el uso de caracteres comodín.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Filter <string>
Especifica un filtro en el formato o lenguaje del proveedor. El valor de este parámetro califica el parámetro Path. La sintaxis del filtro, incluido el uso de caracteres comodín, depende del proveedor. Los filtros son más eficaces que otros parámetros, ya que el proveedor los aplica al recuperar los objetos en lugar de hacer que Windows PowerShell filtre los objetos después de recuperarlos.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Force
Permite al cmdlet borrar elementos que no se pueden cambiar de ningún otro modo, como alias de solo lectura. El cmdlet no puede borrar constantes. La implementación varía según el proveedor. Para obtener más información, vea about_Providers. Incluso si se usa el parámetro Force, el cmdlet no puede invalidar las restricciones de seguridad.
|
¿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 Path. Escriba un patrón o un elemento de la ruta de acceso, como "*.txt". Se permite el uso de caracteres comodín.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-LiteralPath <string[]>
Especifica la ruta de los elementos que se van a borrar. A diferencia de Path, el valor de LiteralPath se usa literalmente como se escribe. Ningún carácter se interpretará como un carácter comodín. Si la ruta incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples indican a Windows PowerShell que no debe interpretar los caracteres como secuencias de escape.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByPropertyName) |
|
¿Aceptar caracteres comodín? |
false |
-Path <string[]>
Especifica la ruta de los elementos que se van a borrar. Se permite el uso de caracteres comodín. Este parámetro es obligatorio, pero el nombre del parámetro ("Path") es opcional.
|
¿Requerido? |
true |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByValue, ByPropertyName) |
|
¿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 |
-UseTransaction
Incluye el comando en la transacción activa. Este parámetro sólo es válido cuando hay una transacción en curso. Para obtener más información, vea about_Transactions.
|
¿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 |
System.String Puede canalizar una cadena de ruta de acceso a Clear-Item. |
|
Salidas |
Ninguno Este cmdlet no devuelve objetos. |
Notas
El cmdlet Clear-Item sólo es compatible con algunos proveedores de Windows PowerShell, como Alias, Environment, Function, Registry y Variable. Así, puede usar Clear-Item para eliminar el contenido de elementos de los espacios de nombres de proveedor.
No puede usar Clear-Item para eliminar el contenido de un archivo, ya que el proveedor FileSystem de Windows PowerShell no admite este cmdlet. Para borrar archivos use Clear-Content.
También puede hacer referencia a Clear-Item mediante su alias integrado, "cli". Para obtener más información, escriba "Get-Help about_Aliases".
El cmdlet Clear-Item está diseñado para funcionar con los datos expuestos por cualquier proveedor. Para mostrar los proveedores que están disponibles en la sesión, escriba "Get-PsProvider". Para obtener más información, vea about_Providers.
Ejemplo 1
C:\PS>clear-item Variable:TestVar1
Descripción
-----------
Este comando elimina el valor de la variable, Testvar1. La variable no se elimina y sigue siendo válida, pero su valor queda establecido en NULL.
El nombre de la variable adquiere el prefijo "Variable:" para indicar el proveedor Variable de Windows PowerShell. Para obtener el mismo resultado, puede cambiar primero al espacio de nombres del proveedor Variable de Windows PowerShell y ejecutar después el comando Clear-Item.
PS C:> Set-location Variable:
PS Variable:\> clear-item Testvar1
Ejemplo 2
C:\PS>clear-item Alias:log* -include *1* -exclude *3* -whatif What if: Performing operation "Clear Item" on Target "Item: log1". Descripción ----------- Este comando pregunta a Windows PowerShell qué sucedería si se ejecuta el comando "clear-item alias:log* -include *1* -exclude *3". Como respuesta, Windows PowerShell explica que eliminaría el valor del alias log1. Este comando no tendría ningún efecto en los alias log, log2 o log13. Dado que el proveedor de alias no permite un alias sin un valor, al borrar un alias, también se elimina el alias.
Ejemplo 3
C:\PS>clear-item registry::HKLM\Software\MyCompany\MyKey -confirm Descripción ----------- Este comando elimina todas las entradas del Registro de la subclave MyKey, pero sólo después de pedirle que confirme que desea hacerlo. No elimina la subclave MyKey ni afecta a ninguna otra clave o entrada del Registro. Puede usar los parámetros Include y Exclude para identificar claves del Registro específicas, pero no puede usarlas para identificar las entradas del Registro. Para eliminar entradas específicas del Registro, use Remove-ItemProperty. Para eliminar el valor de una entrada del Registro, use Clear-ItemProperty.
Vea también