Clear-Item

  • Referência
Módulo:
Microsoft.PowerShell.Management

Limpa o conteúdo de um item, mas não o exclui.

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

O Clear-Item cmdlet limpa o conteúdo de um item, mas não o exclui. Por exemplo, o Clear-Item cmdlet pode excluir o valor de uma variável, mas não exclui a variável. O valor usado para representar um item limpo é definido por cada provedor do PowerShell. Esse cmdlet é semelhante ao Clear-Content, mas funciona em aliases e variáveis, em vez de arquivos.

Exemplos

Exemplo 1: Limpar o valor de uma variável

Esse comando limpa o valor da variável chamada TestVar1. A variável permanece e é válida, mas seu valor é definido como $null. O nome da variável é prefixado com Variable: para indicar o provedor de variáveis do PowerShell.

Os comandos alternativos mostram que, para obter o mesmo resultado, você pode alternar para a unidade do PowerShell Variable: e, em seguida, executar o Clear-Item comando.

Clear-Item Variable:TestVar1

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

Exemplo 2: Limpar todas as entradas do Registro

Esse comando limpa todas as entradas do Registro na subchave "MyKey", mas somente depois de solicitar que você confirme sua intenção. Ele não exclui a subchave "MyKey" nem afeta quaisquer outras chaves ou entradas do Registro. Você pode usar os parâmetros Include e Exclude para identificar chaves do Registro específicas, mas não pode usá-las para identificar entradas do Registro.

  • Para excluir entradas específicas do Registro, use o Remove-ItemProperty cmdlet.
  • Para excluir o valor de uma entrada do Registro, use o Clear-ItemProperty cmdlet.
Clear-Item HKLM:\Software\MyCompany\MyKey -Confirm

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-Credential

Observação

Esse parâmetro não é suportado por nenhum provedor instalado com o PowerShell. Para representar outro usuário ou elevar suas credenciais ao executar esse 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 uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet exclui na operação. O valor desse parâmetro qualifica o parâmetro Path . Insira um elemento ou padrão de caminho, como *.txt. Caracteres curinga são permitidos. O parâmetro Exclude é efetivo somente quando o comando inclui o conteúdo de um item, como , em C:\Windows\*que o caractere curinga C:\Windows especifica o conteúdo do diretório.

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

-Filter

Especifica um filtro para qualificar o parâmetro Path . O provedor FileSystem é o único provedor do PowerShell instalado que oferece suporte ao uso de filtros. Você pode encontrar a sintaxe do idioma de filtro FileSystem em about_Wildcards. Os filtros são mais eficientes do que outros parâmetros, porque o provedor os aplica quando o cmdlet obtém os objetos, em vez de fazer com que o PowerShell filtre os objetos depois que eles são recuperados.

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

-Force

Indica que o cmdlet limpa itens que não podem ser alterados, como aliases somente leitura. O cmdlet não apaga constantes. A implementação varia de provedor para provedor. Para obter mais informações, consulte about_Providers. O cmdlet não pode substituir restrições de segurança, mesmo quando o parâmetro Force é usado.

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

-Include

Especifica, como uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o parâmetro Path . Insira um elemento ou padrão de caminho, como "*.txt". Caracteres curinga são permitidos. O parâmetro Include é efetivo somente quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga C:\Windows especifica o conteúdo do diretório.

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

-LiteralPath

Especifica um caminho para um ou mais locais. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Para obter mais informações, 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 o caminho para os itens sendo apagados. Caracteres curinga são permitidos. Esse parâmetro é obrigatório, mas o nome do parâmetro Path é opcional.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

String

Você pode canalizar uma cadeia de caracteres de caminho para esse cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

O PowerShell inclui os seguintes aliases para Clear-Item:

  • Todas as plataformas:

    • cli

  • O Clear-Item cmdlet é suportado apenas por vários provedores do PowerShell, incluindo os provedores Alias, Environment, Function, Registry e Variable . Como tal, você pode usar Clear-Item para excluir o conteúdo de itens nos namespaces do provedor. Para listar os provedores disponíveis em sua sessão, digite Get-PsProvider. Para obter mais informações, consulte about_Providers.

  • Você não pode usar Clear-Item para excluir o conteúdo de um arquivo, porque o provedor do Sistema de Arquivos do PowerShell não oferece suporte a esse cmdlet. Para limpar arquivos, use o Clear-Content.