Clear-Item

  • Referencia
Módulo:
Microsoft.PowerShell.Management

Borra el contenido de un elemento, pero no elimina el elemento.

Syntax

Clear-Item
     [-Path] <String[]>
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Clear-Item
     -LiteralPath <String[]>
     [-Force]
     [-Filter <String>]
     [-Include <String[]>]
     [-Exclude <String[]>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

El Clear-Item cmdlet borra el contenido de un elemento, pero no elimina el elemento. Por ejemplo, el Clear-Item cmdlet puede eliminar el valor de una variable, pero no elimina la variable. Cada proveedor de PowerShell define el valor que se usa para representar un elemento borrado. Este cmdlet es similar a Clear-Content, pero funciona en alias y variables, en lugar de en archivos.

Ejemplos

Ejemplo 1: Borrar el valor de una variable

Este comando borra el valor de la variable denominada TestVar1. La variable permanece y es válida, pero su valor se establece en $null. El nombre de la variable tiene el prefijo para Variable: indicar el proveedor de variables de PowerShell.

Los comandos alternativos muestran que, para obtener el mismo resultado, puede cambiar a la unidad de PowerShell Variable: y, a continuación, ejecutar el Clear-Item comando.

Clear-Item Variable:TestVar1

Set-Location Variable:
PS Variable:\> Clear-Item TestVar1

Ejemplo 2: Borrar todas las entradas del Registro

Este comando borra todas las entradas del Registro en la subclave "MyKey", pero solo después de solicitarle que confirme la intención. No elimina la subclave "MyKey" ni afecta a ninguna otra clave o entradas del Registro. Puede usar los parámetros Include y Exclude para identificar claves del Registro concretas, pero no puede usarlas para identificar las entradas del Registro.

  • Para eliminar determinadas entradas del Registro, use el Remove-ItemProperty cmdlet .
  • Para eliminar el valor de una entrada del Registro, use .Clear-ItemProperty cmdlet
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm

Parámetros

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Nota:

Este parámetro no es compatible con ningún proveedor instalado con PowerShell. Para suplantar a otro usuario o elevar las credenciales al ejecutar este cmdlet, use Invoke-Command.

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Especifica, como matriz de cadenas, un elemento o elementos que este cmdlet excluye en la operación. El valor de este parámetro califica el parámetro Path . Escriba un elemento o patrón de ruta de acceso, como *.txt. Se permite el uso de caracteres comodín. El parámetro Exclude solo es efectivo cuando el comando incluye el contenido de un elemento, como C:\Windows\*, donde el carácter comodín especifica el contenido del C:\Windows directorio.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Filter

Especifica un filtro para calificar el parámetro Path . El proveedor FileSystem es el único proveedor de PowerShell instalado que admite el uso de filtros. Puede encontrar la sintaxis del lenguaje de filtro FileSystem en about_Wildcards. Los filtros son más eficaces que otros parámetros, ya que el proveedor los aplica cuando el cmdlet obtiene los objetos en lugar de que PowerShell filtre los objetos una vez recuperados.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

Indica que el cmdlet borra los elementos que no se pueden cambiar de otro modo, como alias de solo lectura. El cmdlet no puede borrar constantes. La implementación varía en función del proveedor. Para obtener más información, consulte about_Providers. El cmdlet no puede invalidar las restricciones de seguridad, incluso cuando se usa el parámetro Force .

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

Especifica, como matriz de cadenas, un elemento o elementos que este cmdlet incluye en la operación. El valor de este parámetro califica el parámetro Path . Escriba un elemento o patrón de ruta de acceso, como "*.txt". Se permite el uso de caracteres comodín. El parámetro Include solo es efectivo cuando el comando incluye el contenido de un elemento, como C:\Windows\*, donde el carácter comodín especifica el contenido del C:\Windows directorio.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-LiteralPath

Especifica una ruta de acceso a una o varias ubicaciones. El valor de LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

Para obtener más información, consulte about_Quoting_Rules.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Especifica la ruta de acceso a los elementos que se borran. Se permite el uso de caracteres comodín. Este parámetro es obligatorio, pero el nombre del parámetro Path es opcional.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Puede canalizar una cadena de ruta de acceso a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado.

Notas

PowerShell incluye los siguientes alias para Clear-Item:

  • Todas las plataformas:

    • cli

  • El Clear-Item cmdlet solo es compatible con varios proveedores de PowerShell, incluidos los proveedores alias, entorno, función, registro y variables . Por lo tanto, puede usar Clear-Item para eliminar el contenido de los elementos en los espacios de nombres del proveedor. Para enumerar los proveedores disponibles en la sesión, escriba Get-PsProvider. Para obtener más información, consulte about_Providers.

  • No se puede usar Clear-Item para eliminar el contenido de un archivo, ya que el proveedor FileSystem de PowerShell no admite este cmdlet. Para borrar archivos, use .Clear-Content