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

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

名前
    New-Event
    
概要
    新しいイベントを作成します。
    
構文
    New-Event [-SourceIdentifier] <string> [[-Sender] <psobject>] [[-EventArgume
    nts] <PSObject[]>] [[-MessageData] <psobject>] [<CommonParameters>]
    
説明
    New-Event コマンドレットは、新しいカスタム イベントを作成します。
    
    カスタム イベントを使用すると、プログラムの状態の変更や、ハードウェアやシス
    テムの状態、アプリケーションの状態、ディスクの状態、ネットワークの状態、バッ
    クグラウンド ジョブの完了など、プログラムによって検出された変更をユーザーに
    通知できます。
    
    カスタム イベントが発生すると、セッションのイベント キューに自動的に追加され
    るため、カスタム イベントをサブスクライブする必要はありません。ただし、イベ
    ントをローカル セッションに転送したり、イベントに応答するためのアクションを
    指定したりする場合は、Register-EngineEvent コマンドレットを使用してカスタム 
    イベントをサブスクライブする必要があります。
    
    カスタム イベントをサブスクライブするとき、イベント サブスクライバーがセッシ
    ョンに追加されます。Unregister-Event コマンドレットを使用してイベント サブス
    クリプションをキャンセルすると、イベント サブスクライバーとカスタム イベント
    がセッションから削除されます。カスタム イベントをサブスクライブしない場合は、
    イベントを削除するために、プログラムの状態を変更するか、または Windows Power
    Shell セッションを終了する必要があります。

パラメーター
    -EventArguments <PSObject[]>
        イベントのオプションが格納されているオブジェクトを指定します。
        
        必須                         false
        位置                         3
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -MessageData <psobject>
        このイベントに関連付けられている追加データを指定します。このパラメーター
        の値は、イベント オブジェクトの MessageData プロパティに表示されます。
        
        必須                         false
        位置                         4
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Sender <psobject>
        イベントを発生させるオブジェクトを指定します。既定値は Windows PowerShel
        l エンジンです。
        
        必須                         false
        位置                         2
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -SourceIdentifier <string>
        新しいイベントの名前を指定します。このパラメーターは必須であり、現在のセ
        ッションで一意でなければなりません。
        
        このパラメーターの値は、イベントの SourceIdentifier プロパティに表示され
        ます。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    なし
        パイプを使用してこのコマンドレットに入力を渡すことはできません。
    
出力
    System.Management.Automation.PSEventArgs
        
メモ
        新しいカスタム イベント、イベント サブスクリプション、およびイベント キ
        ューは、現在のセッションにのみ存在します。現在のセッションを閉じた場合、
        イベント キューが破棄され、イベント サブスクリプションが取り消されます。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>new-event -sourceidentifier Timer -sender windows.timer  -messagedata 
    "Test"
    
    説明
    -----------
    このコマンドは、Windows PowerShell イベント キューに新しいイベントを作成しま
    す。イベントを送信するために Windows.Timer オブジェクトを使用します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>function Enable-ProcessCreationEvent 
    { 
       $query = New-Object System.Management.WqlEventQuery "__InstanceCreationEv
       ent", (New-Object TimeSpan 0,0,1), "TargetInstance isa 'Win32_Process'" 
       $processWatcher = New-Object System.Management.ManagementEventWatcher $qu
       ery 
       $identifier = "WMI.ProcessCreated" 
    
       Register-ObjectEvent $processWatcher "EventArrived" -SupportEvent $identi
       fier -Action { 
           [void] (New-Event -sourceID "PowerShell.ProcessCreated" -Sender $args
           [0] -EventArguments $args[1].SourceEventArgs.NewEvent.TargetInstance) 
       } 
    }
    
    説明
    -----------
    このサンプル関数は、New-Event コマンドレットを使用して、他のイベントに応答し
    てイベントを発生させます。Register-ObjectEvent コマンドレットを使用して、新し
    いプロセスの作成時に発生する Windows Management Instrumentation (WMI) イベン
    トをサブスクライブします。また、このコマンドレットの Action パラメーターを使
    用して New-Event コマンドレットを呼び出すことにより、新しいイベントを作成しま
    す。
    
    New-Event によって発生するイベントは自動的に Windows PowerShell イベント キュ
    ーに追加されるため、そのイベントを登録する必要はありません。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=135234
    Register-ObjectEvent 
    Register-EngineEvent 
    Register-WmiEvent 
    Unregister-Event 
    Get-Event 
    Remove-Event 
    Wait-Event 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、New-Event
ご利用数: 1917553
感想・要望・問い合わせは こちら