Clear-Variable
Exclui o valor de uma variável.
Sintaxe
Default (Default)
Clear-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Clear-Variable exclui os dados armazenados em uma variável, mas não exclui a variável. Como resultado, o valor da variável é NULL (vazio). Se a variável tiver um tipo de objeto ou dados especificado, esse cmdlet preservará o tipo do objeto armazenado na variável.
Exemplos
Exemplo 1: remover o valor das variáveis globais que começam com uma cadeia de caracteres de pesquisa
PS C:\> Clear-Variable my* -Scope Global
Esse comando remove o valor das variáveis globais que têm nomes que começam com o meu.
Exemplo 2: Limpar uma variável em um escopo filho, mas não no escopo pai
PS C:\> $a=3
PS C:\> &{ Clear-Variable a }
PS C:\> $a
3
Esses comandos demonstram que limpar uma variável em um escopo filho não limpa o valor no escopo pai. O primeiro comando define o valor da variável $A como 3. O segundo comando usa o operador de invocação (&) para executar o comando Clear-Variable em um novo escopo. A variável é desmarcada no escopo filho (embora não existisse), mas não está desmarcada no escopo local. O terceiro comando, que obtém o valor de $A, mostra que o valor 3 não foi afetado.
Exemplo 3: excluir o valor da variável especificada
PS C:\> Clear-Variable -Name "Processes"
Esse comando exclui o valor da variável chamada Processos. Depois que o cmdlet concluir a operação, a variável denominada Processos ainda existirá, mas o valor será nulo.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Exclude
Especifica uma matriz de itens que esse cmdlet omite na operação. O valor desse parâmetro qualifica o parâmetro Name. Insira um elemento ou padrão de nome, como "s*". Caracteres curinga são permitidos.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Permite que o cmdlet desmarque uma variável mesmo que seja somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode limpar constantes.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Include
Especifica uma matriz de itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o parâmetro Name. Insira um elemento ou padrão de nome, como "s*". Caracteres curinga são permitidos.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Name
Especifica o nome da variável a ser desmarcada. Caracteres curinga são permitidos. Esse parâmetro é necessário, mas o nome do parâmetro ("Name") é opcional.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-PassThru
Retorna um objeto que representa o item com o qual você está trabalhando. Por padrão, esse cmdlet não gera nenhuma saída.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Scope
Especifica o escopo no qual esse alias é válido.
Os valores aceitáveis para este parâmetro são:
- Mundial
- Local
- Script
Você também pode usar um número relativo ao escopo atual (0 por meio do número de escopos, em que 0 é o escopo atual e 1 é o pai). Local é o padrão. Para obter mais informações, consulte about_Scopes.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
None
Você não pode redirecionar objetos para este cmdlet.
Saídas
None or System.Management.Automation.PSVariable
Quando você usa o parâmetro PassThru, esse cmdlet gera um objeto System.Management.Automation.PSVariable que representa a variável desmarcada. Caso contrário, esse cmdlet não gerará nenhuma saída.
Observações
Para excluir uma variável, juntamente com seu valor, use Remove-Variable ou Remover Item.
Esse cmdlet não exclui os valores de variáveis definidas como constantes ou pertencentes ao sistema, mesmo que você use o parâmetro Force.
Se a variável que você está limpando não existir, o cmdlet não terá efeito. Ele não cria uma variável com um valor nulo.
Você também pode consultar de Variável Clara por seu alias interno, clv. Para obter mais informações, consulte about_Aliases.