Clear-Item

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

Sintaxe

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

Descrição

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

Parâmetros

-Credential <PSCredential>

Especifica uma conta de usuário com permissão para executar essa ação. O padrão é o usuário atual.

Digite um nome de usuário, como "User01" ou "Domain01\User01", ou insira um objeto PSCredential, como aquele gerado pelo cmdlet Get-Credential. Uma senha será solicitada após a digitação do nome do usuário.

Este parâmetro não tem suporte em nenhum dos provedores instalados com o Windows PowerShell.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Exclude <string[]>

Omite os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Filter <string>

Especifica um filtro no formato ou no idioma do provedor. O valor desse parâmetro qualifica o parâmetro Path. A sintaxe do filtro, incluindo o uso dos caracteres curinga, depende do provedor. Os filtros são mais eficientes do que outros parâmetros porque o provedor os aplica durante a recuperação dos objetos, em vez de fazer com que o Windows PowerShell os filtre depois de recuperados.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Force

Permite que o cmdlet limpe os itens que não podem ser alterados, como aliases somente leitura. O cmdlet não pode limpar constantes. A implementação varia de provedor para provedor. Para obter mais informações, consulte about_Providers. Mesmo usando o parâmetro Force, o cmdlet não pode substituir as restrições de segurança.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Include <string[]>

Limpa somente os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-LiteralPath <string[]>

Especifica o caminho até os itens que serão limpos. Ao contrário de Path, o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere será interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-os entre aspas simples. As aspas simples dizem ao Windows PowerShell para não interpretar quaisquer caracteres que tenham sequências de escape.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Path <string[]>

Especifica o caminho até os itens que serão limpos. Os caracteres curinga são permitidos. Este parâmetro é obrigatório, mas seu nome ("Path") é opcional.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByValue, ByPropertyName)
Aceitar caracteres curinga?	false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-UseTransaction

Inclui o comando na transação ativa. Este parâmetro é válido apenas quando uma transação está em andamento. Para obter mais informações, consulte about_Transactions.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas	System.String É possível enviar uma cadeia de caracteres de caminho para Clear-Item.
Saídas	Nenhum Este cmdlet não retorna nenhum objeto.

Observações

O cmdlet Clear-Item tem o suporte de somente alguns dos provedores do Windows PowerShell, incluindo os provedores Alias, Environment, Function, Registry e Variable. Assim, você pode usar Clear-Item para excluir o conteúdo de itens dos namespaces do provedor.

Você não pode usar Clear-Item para excluir o conteúdo de um arquivo porque o provedor FileSystem do Windows PowerShell não oferece suporte a esse cmdlet. Utilize Clear-Content para limpar os arquivos.

Você também pode fazer referência a Clear-Item usando seu alias interno, "cli". Para obter mais informações, digite "Get-Helpabout_Aliases".

O cmdlet Clear-Item foi desenvolvido para funcionar com os dados expostos por qualquer provedor. Para listar os provedores disponíveis em sua sessão, digite "Get-PsProvider". Para obter mais informações, consulte about_Providers.

Exemplo 1

C:\PS>clear-item Variable:TestVar1

Descrição
-----------
Esse comando exclui o valor da variável, Testvar1. A variável ainda existe e é válida, mas o seu valor é definido como nulo. 
  
O nome da variável tem o prefixo "Variable:" para indicar o provedor Variable do Windows PowerShell. Para obter o mesmo resultado, primeiro você pode alternar para o namespace do provedor Variable do Windows PowerShell e, em seguida, executar o comando Clear-Item.

    PS C:> Set-location Variable:
    PS Variable:\> clear-item Testvar1

Exemplo 2

C:\PS>clear-item Alias:log* -include *1* -exclude *3* -whatif

What if: Performing operation "Clear Item" on Target "Item: log1".

Descrição
-----------
Esse comando pergunta ao Windows PowerShell o que aconteceria caso você executasse o comando "clear-item alias:log* -include *1* -exclude *3". Em resposta, o Windows PowerShell explica que ele excluiria o valor do alias log1. 

Esse comando não teria nenhum efeito nos aliases log, log2 ou log13. Como o provedor Alias não permite um alias sem um valor, quando você limpa um alias, também o exclui.

Exemplo 3

C:\PS>clear-item registry::HKLM\Software\MyCompany\MyKey -confirm

Descrição
-----------
Esse comando exclui todas as entradas do Registro na subchave MyKey, mas somente depois de solicitar que você confirme a sua intenção. Ele não exclui a subchave MyKey ou afeta qualquer outra chave ou entrada 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 Remove-ItemProperty. Para excluir o valor de uma entrada do Registro, use Clear-ItemProperty.

Consulte também

Conceitos

about_Providers
Copy-Item
Get-Item
Invoke-Item
Move-Item
Set-Item
New-Item
Remove-Item
Rename-Item