Clear-Variable
Exclui o valor de uma variável.
Sintaxe
Default (Predefinição)
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 de variáveis globais que começam com uma cadeia de caracteres de pesquisa
PS C:\> Clear-Variable my* -Scope Global
Este comando remove o valor das variáveis globais que têm nomes que começam com my.
Exemplo 2: Limpar uma variável em um escopo filho, mas não o 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 invoke (&) para executar o comando Clear-Variable em um novo escopo. A variável é limpa no escopo filho (embora não existisse), mas não é limpa no escopo local. O terceiro comando, que obtém o valor de $A, mostra que o valor 3 não é afetado.
Exemplo 3: Excluir o valor da variável especificada
PS C:\> Clear-Variable -Name "Processes"
Este comando exclui o valor da variável chamada Processes. Depois que o cmdlet conclui a operação, a variável chamada Processes ainda existe, mas o valor é null.
Parâmetros
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Exclude
Especifica uma matriz de itens que esse cmdlet omite na operação. O valor desse parâmetro qualifica o Name parâmetro. Insira um elemento ou padrão de nome, como "s*". Curingas são permitidos.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Force
Permite que o cmdlet limpe uma variável mesmo que ela seja somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode limpar constantes.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Include
Especifica uma matriz de itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o Name parâmetro. Insira um elemento ou padrão de nome, como "s*". Curingas são permitidos.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Name
Especifica o nome da variável a ser limpa. Curingas são permitidos. Este parâmetro é necessário, mas o nome do parâmetro ("Name") é opcional.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | 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 dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Scope
Especifica o escopo no qual esse alias é válido.
Os valores aceitáveis para este parâmetro são:
- A nível mundial
- Locais
- Script
Você também pode usar um número relativo ao escopo atual (0 até o 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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
Não é possível canalizar 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 limpa. Caso contrário, esse cmdlet não gerará nenhuma saída.
Notas
Para excluir uma variável, juntamente com seu valor, use Remove-Variable ou Remove-Item.
Este cmdlet não exclui os valores de variáveis definidas como constantes ou de propriedade do sistema, mesmo se você usar 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 se referir a Clear-Variable por seu alias interno, clv. Para obter mais informações, consulte about_Aliases.