PowerShell Alias - clv
 記事記号:[mcAc72] 初版:2010/Dec/28

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Clear-Variable
    
概要
    変数の値を削除します。
    
構文
    Clear-Variable [-Name] <string[]> [-Exclude <string[]>] [-Force]
    [-Include <string[]>] [-PassThru] [-Scope <string>] [-Confirm] 
    [-WhatIf] [<CommonParameters>]
    
    
説明
    Clear-Variable コマンドレットは変数に保存されているデータを削除しますが、変数
    は削除しません。その結果、変数の値は NULL (空) になります。変数にデータ型また
    はオブジェクト型が指定されている場合、Clear-Variable は変数に保存されているオ
    ブジェクトの型を保持します。
    
パラメーター
    -Exclude <string[]>
        指定した項目を除外します。このパラメーターの値は、Name パラメーターを修
        飾します。"s*" などの名前要素またはパターンを入力します。ワイルドカード
        を使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        変数が読み取り専用であっても、コマンドレットにより変数をクリアできるよう
        にします。Force パラメーターを使用しても、コマンドレットで定数をクリアす
        ることはできません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Include <string[]>
        指定した項目だけを削除します。このパラメーターの値は、Name パラメーターを
        修飾します。"s*" などの名前要素またはパターンを入力します。ワイルドカード
        を使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string[]>
        クリアする変数の名前を指定します。ワイルドカードを使用できます。このパラ
        メーターは必須ですが、パラメーター名 ("Name") は省略可能です。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        クリアされた変数を表すオブジェクトを返します。既定では、このコマンドレッ
        トによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Scope <string>
        このエイリアスが有効なスコープを指定します。指定可能な値は、Global、Loca
        l、Script、または現在のスコープの相対的な数値 (0 〜スコープの数。ここで 
        0 は現在のスコープを表し、1 はその親を表す) です。既定値は Local です。 
        詳細については、「about_Scopes」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    なし
        パイプを使用してオブジェクトを Clear-Variable に渡すことはできません。
    
出力
    なし、または System.Management.Automation.PSVariable
        PassThru パラメーターを使用すると、Clear-Variable はクリアされた変数を表
        す System.Management.Automation.PSVariable オブジェクトを生成します。それ
        以外の場合、このコマンドレットによる出力はありません。
    
メモ
        変数およびその値を削除するには、Remove-Variable または Remove-Item を使用
        します。
        
        Clear-Variable は、-Force パラメーターが使用されている場合でも、定数とし
        て設定されている値、またはシステムによって所有されている変数の値を削除す
        ることはありません。
        
        クリアする変数が存在しない場合、コマンドレットの効果はありません。null 値
        を持つ変数は作成されません。
        
        Clear-Variable は、その組み込みエイリアスである "clv" で参照することもでき
        ます。詳細については、「about_Aliases」を参照してください。
    
    -------------------------- 例 1 --------------------------
    C:\PS>clear-variable my* -global
    
    説明
    -----------
    このコマンドは、"my" という文字で始まるグローバル変数の値を削除します。
    
    -------------------------- 例 2 --------------------------
    C:\PS>$a=3
    
    C:\PS>&{ clear-variable a }
    
    C:\PS>$a
    3
    
    説明
    -----------
    これらのコマンドは、子スコープ内の変数をクリアしても親スコープ内の値はクリア
    されないことを示します。最初のコマンドは、変数 $a の値を "3" に設定します。2 
    番目のコマンドは、呼び出し演算子 (&) を使用し、新しいスコープ内で Clear-Vari
    able コマンドを実行します。変数は子スコープ (今回は存在しません) でクリアされ
    ますが、ローカル スコープではクリアされません。3 番目のコマンドは、$a の値を
    取得し、"3" という値に変化がないことを示しています。
    
    -------------------------- 例 3 --------------------------
    C:\PS>clear-variable -name processes
    
    説明
    -----------
    このコマンドは、$processes 変数の値を削除します。$processes 変数は引き続き存
    在しますが、値は null になります。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113285
    Get-Variable 
    Set-Variable 
    New-Variable 
    Remove-Variable 
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、clv
ご利用数: 1913404
感想・要望・問い合わせは こちら