イベント キューからイベントを削除します。
構文
Remove-Event [-EventIdentifier] <int> [-確認] [-WhatIf] [<CommonParameters>] Remove-Event [-SourceIdentifier] <string> [-確認] [-WhatIf] [<CommonParameters>]
説明
Remove-Event コマンドレットは、現在のセッションのイベント キューからイベントを削除します。
このコマンドレットは、現在キューにあるイベントのみを削除します。イベントの登録をキャンセルしたり、サブスクライブを解除したりする場合は、Unregister-Event コマンドレットを使用します。
パラメーター
-EventIdentifier <int>
指定されたイベント識別子を持つイベントのみを削除します。EventIdentifier パラメーターまたは SourceIdentifier パラメーターはすべてのコマンドに必要です。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
なし |
|
パイプライン入力を許可する |
true (ByPropertyName) |
|
ワイルドカード文字を許可する |
false |
-SourceIdentifier <string>
指定されたソース識別子を持つイベントのみを削除します。ワイルドカードは使用できません。EventIdentifier パラメーターまたは SourceIdentifier パラメーターはすべてのコマンドに必要です。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
なし |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-確認
コマンドを実行する前に確認メッセージを表示します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
System.Management.Automation.PSEventArgs イベントを Get-Event から Remove-Event にパイプ処理できます。 |
|
出力 |
なし このコマンドレットは出力を生成しません。 |
注
イベント、イベント サブスクリプション、およびイベント キューは、現在のセッションにのみ存在します。現在のセッションを閉じた場合、イベント キューが破棄され、イベント サブスクリプションが取り消されます。
例 1
C:\PS>remove-event -sourceIdentifier "ProcessStarted" 説明 ----------- このコマンドは、ソース識別子が "Process Started" であるイベントをイベント キューから削除します。
例 2
C:\PS>remove-event -eventIdentifier 30 説明 ----------- このコマンドは、イベント ID が 30 であるイベントをイベント キューから削除します。
例 3
C:\PS>get-event | remove-event 説明 ----------- このコマンドは、イベント キューからすべてのイベントを削除します。
関連項目