Remove-Variable

Artigo
10/30/2009

Exclui a variável e seu valor.

Sintaxe

Remove-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Descrição

O cmdlet Remove-Variable exclui uma variável e seu valor do escopo no qual está definido, como a sessão atual. Você não pode usar esse cmdlet para excluir variáveis que estejam definidas como constantes ou sejam de propriedade do sistema.

Parâmetros

-Exclude <string[]>

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

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

-Force

Permitirá que o cmdlet remova uma variável mesmo se ela for somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode remover uma constante.

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

-Include <string[]>

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

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

-Name <string[]>

Especifica o nome da variável a ser removida. O nome do parâmetro ("Name") é opcional.

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

-Scope <string>

Especifica o escopo no qual este alias é válido. Os valores válidos são "Global", "Local" ou "Script" ou um número relativo ao atual escopo (0 ao número de escopos, onde 0 é o escopo atual e 1 é seu pai). "Local" é o padrão. Para obter mais informações, consulte about_Scopes.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
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

<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.Management.Automation.PSVariable

Você pode canalizar um objeto de variável para Remove-Variable.

Saídas

Nenhum

Este cmdlet não retorna nenhuma saída.

Observações

As alterações afetam apenas o escopo atual, como uma sessão. Para excluir uma variável de todas as sessões. adicione o comando Remove-Variable a seu perfil do Windows PowerShell.

Você também pode se referir a RemoveVariable usando seu alias interno, "rv". Para obter mais informações, consulte about_Aliases.

Exemplo 1

C:\PS>remove-variable Smp

Descrição
-----------
Esse comando exclui a variável $Smp.

Consulte também

Conceitos

Set-Variable
Get-Variable
Clear-Variable
New-Variable
about_Profiles

Compartilhar via