Clear-Variable
Menghapus nilai variabel.
Sintaks
Clear-Variable
[-Name] <String[]>
[-Include <String[]>]
[-Exclude <String[]>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Deskripsi
Clear-Variable
Cmdlet menghapus data yang disimpan dalam variabel, tetapi tidak menghapus variabel. Akibatnya, nilai variabel adalah NULL (kosong). Jika variabel memiliki data atau jenis objek tertentu, cmdlet ini mempertahankan jenis objek yang disimpan dalam variabel.
Contoh
Contoh 1: Hapus nilai variabel global yang dimulai dengan string pencarian
Clear-Variable my* -Scope Global
Perintah ini menghapus nilai variabel global yang memiliki nama yang dimulai dengan saya.
Contoh 2: Menghapus variabel dalam cakupan anak tetapi bukan cakupan induk
$a=3
&{ Clear-Variable a }
$a
3
Perintah ini menunjukkan bahwa menghapus variabel dalam cakupan anak tidak menghapus nilai dalam cakupan induk. Perintah pertama mengatur nilai variabel $a
menjadi 3. Perintah kedua menggunakan operator pemanggilan (&
) untuk menjalankan Clear-Variable
perintah dalam cakupan baru. Variabel dibersihkan dalam cakupan anak (meskipun tidak ada), tetapi tidak dihapus dalam cakupan lokal.
Perintah ketiga, yang mendapatkan nilai $a
, menunjukkan bahwa nilai 3 tidak terpengaruh.
Contoh 3: Menghapus nilai variabel yang ditentukan
Clear-Variable -Name "Processes"
Perintah ini menghapus nilai variabel bernama Proses. Setelah cmdlet menyelesaikan operasi, variabel bernama Proses masih ada, tetapi nilainya null.
Parameter
-Confirm
Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.
Jenis: | SwitchParameter |
Alias: | cf |
Position: | Named |
Nilai default: | False |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Exclude
Menentukan array item yang dihilangkan cmdlet ini dalam operasi. Nilai parameter ini memenuhi syarat parameter Nama . Masukkan elemen atau pola nama, seperti "s*". Kartubebas diizinkan.
Jenis: | String[] |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | True |
-Force
Memungkinkan cmdlet menghapus variabel meskipun bersifat baca-saja. Bahkan menggunakan parameter Force, cmdlet tidak dapat menghapus konstanta.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Include
Menentukan array item yang disertakan cmdlet ini dalam operasi. Nilai parameter ini memenuhi syarat parameter Nama . Masukkan elemen atau pola nama, seperti "s*". Kartubebas diizinkan.
Jenis: | String[] |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | True |
-Name
Menentukan nama variabel yang akan dihapus. Kartubebas diizinkan. Parameter ini diperlukan, tetapi nama parameter Nama bersifat opsional.
Jenis: | String[] |
Position: | 0 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | True |
Terima karakter wildcard: | True |
-PassThru
Mengembalikan objek yang mewakili item tempat Anda bekerja. Secara default, cmdlet ini tidak menghasilkan output apa pun.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Scope
Menentukan cakupan di mana alias ini valid.
Nilai yang dapat diterima untuk parameter ini adalah:
Global
Local
Script
Anda juga dapat menggunakan angka yang relatif terhadap cakupan saat ini (0 hingga jumlah cakupan, di mana 0 adalah cakupan saat ini dan 1 adalah induknya). Lokal adalah default. Untuk informasi selengkapnya, lihat about_Scopes.
Jenis: | String |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-WhatIf
Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.
Jenis: | SwitchParameter |
Alias: | wi |
Position: | Named |
Nilai default: | False |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
Input
None
Anda tidak dapat menyalurkan objek ke cmdlet ini.
Output
None
Secara default, cmdlet ini tidak mengembalikan output.
Saat Anda menggunakan parameter PassThru , cmdlet ini mengembalikan objek PSVariable yang mewakili variabel yang dihapus.
Catatan
Windows PowerShell menyertakan alias berikut untuk Clear-Variable
:
clv
Untuk menghapus variabel, bersama dengan nilainya, gunakan
Remove-Variable
atauRemove-Item
.Cmdlet ini tidak menghapus nilai variabel yang ditetapkan sebagai konstanta atau dimiliki oleh sistem, bahkan jika Anda menggunakan parameter Force .
Jika variabel yang Anda hapus tidak ada, cmdlet tidak berpengaruh. Ini tidak membuat variabel dengan nilai null.