Bagikan melalui

Clear-Variable

Modul:
Microsoft.PowerShell.Utility Module

Menghapus nilai variabel.

Sintaks

Default (Default) 

Clear-Variable
    [-Name] <String[]>
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Force]
    [-PassThru]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

cmdlet Clear-Variable 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 ke 3. Perintah kedua menggunakan operator pemanggilan (&) untuk menjalankan perintah Clear-Variable 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 konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:Cf

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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*". Kartu liar diizinkan.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Force

Memungkinkan cmdlet menghapus variabel meskipun bersifat baca-saja. Bahkan menggunakan parameter Force, cmdlet tidak dapat menghapus konstanta.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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*". Kartu liar diizinkan.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Name

Menentukan nama variabel yang akan dihapus. Kartu liar diizinkan. Parameter ini diperlukan, tetapi nama parameter Nama bersifat opsional.

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-PassThru

Mengembalikan objek yang mewakili item dengan mana Anda bekerja. Secara default, cmdlet ini tidak menghasilkan output apa pun.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:wi

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Secara default, cmdlet ini tidak mengembalikan output.

PSVariable

Saat Anda menggunakan parameter PassThru, cmdlet ini mengembalikan objek PSVariable yang mewakili variabel yang dihapus.

Catatan

PowerShell menyertakan alias berikut untuk Clear-Variable:

  • Semua platform:

    • clv

  • Untuk menghapus variabel, bersama dengan nilainya, gunakan Remove-Variable atau Remove-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.