Elimina il valore di una variabile.
Sintassi
Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force] [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Descrizione
Il cmdlet Clear-Variable consente di eliminare i dati archiviati in una variabile ma non di eliminare la variabile. Di conseguenza, il valore della variabile sarà NULL (vuota). Se per la variabile è stato specificato un tipo di dati o di oggetto, Clear-Variable manterrà il tipo dell'oggetto archiviato nella variabile.
Parametri
-Exclude <string[]>
Omette gli elementi specificati. Il valore di questo parametro qualifica il parametro Name. Immettere un criterio o un elemento del nome, ad esempio "s*". È consentito l'utilizzo di caratteri jolly.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Force
Consente al cmdlet di cancellare una variabile anche se è di sola lettura. Anche se si utilizza il parametro Force, il cmdlet non può cancellare le costanti.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Include <string[]>
Cancella unicamente gli elementi specificati. Il valore di questo parametro qualifica il parametro Name. Immettere un criterio o un elemento del nome, ad esempio "s*". È consentito l'utilizzo di caratteri jolly.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Name <string[]>
Specifica il nome della variabile da eliminare. È consentito l'utilizzo di caratteri jolly. Questo parametro è obbligatorio, ma il nome del parametro ("Name") è facoltativo.
|
Obbligatorio? |
true |
|
Posizione? |
1 |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
true (ByPropertyName) |
|
Accettare caratteri jolly? |
false |
-PassThru
Restituisce un oggetto che rappresenta la variabile cancellata. Per impostazione predefinita, il cmdlet non genera alcun output.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Scope <string>
Specifica l'ambito in cui l'alias è considerato valido. I valori validi sono "Global", "Local", "Script" oppure un numero relativo all'ambito corrente, ovvero da 0 al numero di ambiti, dove 0 corrisponde all'ambito corrente e 1 al relativo padre. Il valore predefinito è "Local". Per ulteriori informazioni, vedere about_Scopes.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Confirm
Chiede una conferma prima di eseguire il comando.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-WhatIf
Descrive ciò che accadrebbe se si eseguisse il comando senza eseguirlo realmente.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
<CommonParameters>
Questo cmdlet supporta i parametri comuni -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Per ulteriori informazioni, vedere about_Commonparameters.
Input e output
Il tipo di input è il tipo degli oggetti che è possibile reindirizzare al cmdlet. Il tipo restituito è il tipo degli oggetti restituiti dal cmdlet.
|
Input |
Nessuno Non è possibile reindirizzare oggetti a Clear-Variable. |
|
Output |
Nessuno o System.Management.Automation.PSVariable Quando si utilizza il parametro PassThru, Clear-Variable genera un oggetto System.Management.Automation.PSVariable che rappresenta la variabile cancellata. Negli altri casi, il cmdlet non genera alcun output. |
Note
Per eliminare una variabile unitamente al relativo valore, utilizzare Remove-Variable o Remove-Item.
Clear-Variable non eliminerà i valori di variabili impostate come costanti o di proprietà del sistema, anche se si utilizza il parametro -Force.
Se la variabile da cancellare non esiste, il cmdlet non ha nessun effetto e non viene creata una variabile con valore Null.
È inoltre possibile fare riferimento a Clear-Variable tramite il relativo alias predefinito "clv". Per ulteriori informazioni, vedere about_Aliases.
Esempio 1
C:\PS>clear-variable my* -global Descrizione ----------- Tramite questo comando verrà eliminato il valore delle variabili globali che iniziano con "my".
Esempio 2
C:\PS>$a=3
C:\PS>&{ clear-variable a }
C:\PS>$a
3
Descrizione
-----------
Tramite questi comandi verrà dimostrato che la cancellazione di una variabile in un ambito figlio non implica la cancellazione del valore nell'ambito padre. Il primo comando imposta il valore della variabile $a su "3". Nel secondo comando viene utilizzato l'operatore invoke (&) per eseguire il comando Clear-Variable in un nuovo ambito. La variabile verrà cancellata nell'ambito figlio, sebbene non esistente, ma non nell'ambito locale. Con il terzo comando, che consente di ottenere il valore di $a, verrà dimostrato che la cancellazione non ha interessato il valore 3.
Esempio 3
C:\PS>clear-variable -name processes Descrizione ----------- Tramite questo comando verrà eliminato il valore della variabile $processes. La variabile è ancora esistente ma il relativo valore è Null.
Vedere anche