PowerShell Cmdlet - Remove-ItemProperty
 記事記号:[mg1958] 初版:2011/Sep/30

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

名前
    Remove-ItemProperty
    
概要
    項目からプロパティとその値を削除します。
    
構文
    Remove-ItemProperty [-LiteralPath] <string[]> [-Name] <string[]> [-Credentia
    l <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Includ
    e <string[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
    
    Remove-ItemProperty [-Path] <string[]> [-Name] <string[]> [-Credential <PSCr
    edential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <stri
    ng[]>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
    
説明
    Remove-ItemProperty コマンドレットは、項目からプロパティとその値を削除します。
    これを使用して、レジストリ値とその中に格納されているデータを削除することがで
    きます。
    
パラメーター
    -Credential <PSCredential>
        この処理を実行するアクセス許可を持つユーザー アカウントを指定します。既
        定値は現在のユーザーです。
        
        "User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Creden
        tial コマンドレットで生成されるような PSCredential オブジェクトを入力し
        ます。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示され
        ます。
        
        このパラメーターは、Windows PowerShell でインストールされるプロバイダー
        ではサポートされていません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Exclude <string[]>
        指定した項目を除外します。このパラメーターの値は、Path パラメーターを修
        飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルドカー
        ドを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Filter <string>
        プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、
        Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、
        フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメ
        ーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Window
        s PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取得
        する際にプロバイダーがフィルターを適用するためです。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        設定しないとユーザーがアクセスできないオブジェクトのプロパティをコマンド
        レットで削除できるようにします。実装はプロバイダーごとに異なります。詳細
        については、「about_Providers」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Include <string[]>
        指定した項目だけを削除します。このパラメーターの値は、Path パラメーター
        を修飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルド
        カードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -LiteralPath <string[]>
        項目プロパティへのパスを指定します。LiteralPath の値は、入力した内容のま
        ま使用されます。ワイルドカードとして解釈される文字はありません。パスにエ
        スケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符で囲ん
        だ文字はエスケープ シーケンスとして解釈されません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Name <string[]>
        取得するプロパティの名前を指定します。
        
        必須                         true
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する 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
        パイプを使用してパス (リテラル パスではない) を含む文字列を Remove-ItemP
        roperty に渡すことができます。
    
出力
    なし
        このコマンドレットによる戻り値はありません。
    
メモ
        Remove-ItemProperty は、その組み込みエイリアスである "rp" で参照すること
        もできます。詳細については、「about_Alias」を参照してください。
        
        Windows PowerShell Registry プロバイダーでは、レジストリ値はレジストリ 
        キーまたはサブキーのプロパティと見なされます。ItemProperty コマンドレッ
        トを使用して、これらの値を管理できます。
        
        Remove-ItemProperty コマンドレットは、プロバイダーによって公開されてい
        るデータを使用するように設計されています。セッションで使用可能なプロバ
        イダーの一覧を表示するには、「Get-PSProvider」と入力します。詳細につい
        ては、「about_Providers」を参照してください。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>remove-itemproperty -path HKLM:\Software\SmpApplication -name SmpPrope
    rty
    
    説明
    -----------
    このコマンドを実行すると、HKEY_LOCAL_MACHINE\Software レジストリ キーの SmpA
    pplication サブキーから、レジストリ値 SmpProperty とそのデータが削除されます。
    
    このコマンドはファイル システム ドライブ (C:\PS>) から実行しているので、ドラ
    イブ HKLM: と Software キーを含む、SmpApplication サブキーへの完全修飾パスを
    使用しています。
    
    削除対象のレジストリ値は、Name パラメーターを使用して指定しています。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>set-location HKCU:\Software\MyCompany\MyApp
    
    PS HKCU:\Software\MyCompany\MyApp> remove-itemproperty -path . -Name Options 
    -confirm
    
    説明
    -----------
    これらのコマンドを実行すると、HKEY_CURRENT_USER\Software\MyCompany の MyApp 
    サブキーから、レジストリ値 Options とそのデータが削除されます。
    
    最初のコマンドでは、Set-Location コマンドレットを使用して現在の場所を HKEY_C
    URRENT_USER ドライブ (HKCU:) および Software\MyCompany\MyApp サブキーに変更
    しています。
    
    2 番目のコマンドでは、Remove-Item コマンドレットを使用して、MyApp サブキーか
    らレジストリ値 Options とそのデータを削除しています。Path パラメーターは必須
    であるため、ドット (.) を使用して現在の場所を示しています。また、Name パラメ
    ーターを使用して、削除対象のレジストリ値を指定しています。さらに、Confirm パ
    ラメーターを使用して、値を削除する前に確認メッセージを表示するよう指示してい
    ます。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>get-item -path HKLM:\Software\MyCompany | remove-itemproperty -name No
    OfEmployees
    
    説明
    -----------
    このコマンドを実行すると、HKLM\Software\MyCompany レジストリ キーから、レジス
    トリ値 NoOfEmployees とそのデータが削除されます。
    
    このコマンドは、Get-Item コマンドレットを使用して、レジストリ キーを表す項目
    を取得します。このコマンドは、パイプライン演算子 (|) を使用して、オブジェクト
    を Remove-ItemProperty コマンドレットに送信します。その後、Remove-ItemPropert
    y の Name パラメーターを使用して、レジストリ値の名前を指定します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113374
    about_Providers 
    Clear-ItemProperty 
    Copy-ItemProperty 
    Get-ItemProperty 
    Move-ItemProperty 
    New-ItemProperty 
    Remove-Item 
    Rename-ItemProperty 
    Set-ItemProperty 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Remove-ItemProperty
ご利用数: 1857614
感想・要望・問い合わせは こちら