PowerShell Alias - cli
 記事記号:[mcAc71] 初版:2010/Dec/28

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

名前
    Clear-ItemProperty
    
概要
    プロパティの値を削除しますがプロパティ自体は削除しません。
    
構文
    Clear-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-
    Credential <PSCredential>] [-Exclude <string[]>] [-Filter <
    string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-Wha
    tIf] [-UseTransaction] [<CommonParameters>]
    
    Clear-ItemProperty [-Path] <string[]> [-Name] <string> [-Credent
    ial <PSCredential>] [-Exclude <string[]>] [-Filter <string>
    ] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-Use
    Transaction] [<CommonParameters>]
    
説明
    Clear-ItemProperty コマンドレットはプロパティの値を削除します。プロパティ自体
    は削除しません。このコマンドレットを使用して、レジストリ値からデータを削除でき
    ます。

パラメーター
    -Credential <PSCredential>
        この処理を実行するアクセス許可を持つユーザー アカウントを指定します。既
        定値は現在のユーザーです。
        
        "User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Creden
        tial コマンドレットで生成されるような PSCredential オブジェクトを入力しま
        す。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されま
        す。
        
        このパラメーターは、Windows PowerShell でインストールされるプロバイダーで
        はサポートされていません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Exclude <string[]>
        指定した項目を除外します。このパラメーターの値は、Path パラメーターを修
        飾します。"*.txt" や "s*" などのパス要素またはパターンを入力します。ワイ
        ルドカードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Filter <string>
        プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、
        Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、
        フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメ
        ーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Windo
        ws PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取
        得する際にプロバイダーがフィルターを適用するためです。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        設定しないとユーザーがアクセスできない項目からプロパティをコマンドレット
        で削除できるようにします。実装はプロバイダーごとに異なります。詳細につい
        ては、「about_Providers」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Include <string[]>
        指定した項目だけを削除します。このパラメーターの値は、Path パラメーター
        を修飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルド
        カードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -LiteralPath <string[]>
        削除するプロパティのパスを指定します。Path と異なり、LiteralPath の値は
        入力したとおりに使用されます。ワイルドカードとして解釈される文字はありま
        せん。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単
        一引用符で囲んだ文字はエスケープ シーケンスとして解釈されません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Name <string>
        レジストリ値の名前など、削除するプロパティの名前を指定します。ワイルドカ
        ードは使用できません。
        
        必須                         true
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        クリアされた項目のプロパティを表すオブジェクトを返します。既定では、この
        コマンドレットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string[]>
        削除するプロパティのパスを指定します。ワイルドカードを使用できます。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByValue, ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -UseTransaction [<SwitchParameter>]
        コマンドを有効なトランザクションに含めます。このパラメーターは、トランザ
        クションの進行中のみ有効です。詳細については、「about_Transactions」を参
        照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.String
        パイプを使用してパス文字列を Clear-ItemProperty に渡すことができます。
    
出力
    なし、または System.Management.Automation.PSCustomObject
        PassThru パラメーターを使用する場合は、Clear-ItemProperty によって、クリ
        アされた項目のプロパティを表す PSCustomObject オブジェクトが生成されます。
        それ以外の場合、このコマンドレットによる出力はありません。
    
メモ
        Clear-ItemProperty を使用すると、レジストリ値自体は削除せずに、レジスト
        リ値のデータを削除することができます。値のデータ型が Binary または DWORD 
        の場合、データをクリアすると値にゼロが設定されます。それ以外の型の場合は、
        値は空になります。
        
        Clear-ItemProperty は、その組み込みエイリアスである "clp" で参照すること
        もできます。詳細については、「about_Aliases」を参照してください。
        
        Clear-ItemProperty コマンドレットは、プロバイダーによって公開されているデ
        ータを使用するように設計されています。セッションで使用可能なプロバイダー
        の一覧を表示するには、「Get-PSProvider」と入力します。詳細については、
        「about_Providers」を参照してください。
    
    -------------------------- 例 1 --------------------------
    C:\PS>clear-itemproperty -path HKLM:\Software\MyCompany\MyApp -name Options
    
    説明
    -----------
    このコマンドを実行すると、HKEY_LOCAL_MACHINE\Software\MyCompany の MyApp サ
    ブキー内のレジストリ値 Options のデータが削除されます。
    
    コマンドはファイル システム ドライブ (C:) から実行されているため、HKLM: ドラ
    イブと Software\MyCompany\MyApp サブキーへの完全修飾パスを使用しています。ま
    た、Name パラメーターを使用して Options の値を指定しています。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113284
    about_Providers 
    Copy-ItemProperty 
    New-ItemProperty 
    Move-ItemProperty 
    Rename-ItemProperty 
    Get-ItemProperty 
    New-ItemProperty 
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、cli
ご利用数: 1918660
感想・要望・問い合わせは こちら