PowerShell Cmdlet - Unregister-Event
 記事記号:[mh1923] 初版:2011/Sep/30

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

名前
    Unregister-Event
    
概要
    イベント サブスクリプションをキャンセルします。
    
構文
    Unregister-Event [-SubscriptionId] <int> [-Force] [-Confirm] [-WhatIf] [<Com
    monParameters>]
    
    Unregister-Event [-SourceIdentifier] <string> [-Force] [-Confirm] [-WhatIf] 
    [<CommonParameters>]
    
説明
    Unregister-Event コマンドレットは、Register-EngineEvent コマンドレット、Regi
    ster-ObjectEvent コマンドレット、または Register-WmiEvent コマンドレットを使
    用して作成されたイベント サブスクリプションをキャンセルします。
    
    イベント サブスクリプションをキャンセルした場合、イベント サブスクライバーは
    セッションから削除され、サブスクライブされたイベントはイベント キューに追加
    されなくなります。New-Event コマンドレットを使用して作成されたイベントへのサ
    ブスクリプションをキャンセルした場合は、新しいイベントもセッションから削除さ
    れます。
    
    Unregister-Event では、イベント キューからイベントが削除されません。イベント
    を削除するには、Remove-Event コマンドレットを使用します。
    
パラメーター
    -Force [<SwitchParameter>]
        Register-ObjectEvent、Register-WmiEvent、および Register-EngineEvent の 
        SupportEvent パラメーターを使用して非表示にしたサブスクリプションなど、
        すべてのイベント サブスクリプションをキャンセルします。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -SourceIdentifier <string>
        指定したソース識別子があるイベント サブスクリプションをキャンセルします。
        
        SourceIdentifier パラメーターまたは SubscriptionId パラメーターはすべて
        のコマンドに含まれている必要があります。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -SubscriptionId <int>
        指定したサブスクリプション識別子があるイベント サブスクリプションをキャ
        ンセルします。
        
        SourceIdentifier パラメーターまたは SubscriptionId パラメーターはすべて
        のコマンドに含まれている必要があります。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する 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」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.PSEventSubscriber
        Get-EventSubscriber からの出力を Unregister-Event にパイプ処理できます。
    
出力
    なし
        このコマンドレットによる戻り値はありません。
    
メモ
        イベント、イベント サブスクリプション、およびイベント キューは、現在のセ
        ッションにのみ存在します。現在のセッションを閉じた場合、イベント キュー
        が破棄され、イベント サブスクリプションが取り消されます。
        
        Register-EngineEvent コマンドレットを使用してイベントにサブスクライブし
        ていなければ、New-Event コマンドレットを使用して作成されたイベントを Unr
        egister-Event で削除することはできません。セッションからカスタム イベン
        トを削除するには、プログラムによって削除するか、セッションを閉じる必要が
        あります。
    
    -------------------------- 例 1 --------------------------
    
    C:\PS>unregister-event -sourceIdentifier ProcessStarted
    
    説明
    -----------
    このコマンドは、ソース識別子が "ProcessStarted" であるイベント サブスクリプ
    ションをキャンセルします。
    
    イベントのソース識別子を検索するには、Get-Event コマンドレットを使用します。
    イベント サブスクリプションのソース識別子を検索するには、Get-EventSubscriber 
    コマンドレットを使用します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>unregister-event -subscriptionId 2
    
    説明
    -----------
    このコマンドは、サブスクリプション識別子が 2 であるイベント サブスクリプショ
    ンをキャンセルします。
    
    イベント サブスクリプションのサブスクリプション識別子を検索するには、Get-Even
    tSubscriber コマンドレットを使用します。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>get-eventsubscriber -force | unregister-event -force
    
    説明
    -----------
    このコマンドは、セッション内のすべてのイベント サブスクリプションをキャンセル
    します。
    
    このコマンドは Get-EventSubscriber コマンドレットを使用して、セッション内のイ
    ベント サブスクライバー オブジェクトをすべて取得します。これには、イベント登
    録コマンドレットの SupportEvent パラメーターを使用して非表示にしているサブス
    クライバーも含まれます。
    
    パイプライン演算子 (|) を使用して、サブスクライバー オブジェクトを Unregister
    -Event に渡します。このコマンドレットは、セッションからサブスクライバー オブ
    ジェクトを削除します。タスクを完了するには、Force パラメーターも Unregister-E
    vent で必須です。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=135269
    Register-ObjectEvent 
    Register-EngineEvent 
    Register-WmiEvent 
    Unregister-Event 
    Get-Event 
    New-Event 
    Remove-Event 
    Wait-Event 
    Get-EventSubscriber 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Unregister-Event
ご利用数: 1975231
感想・要望・問い合わせは こちら