從事件佇列刪除事件。
語法
Remove-Event [-EventIdentifier] <int> [-Confirm] [-WhatIf] [<CommonParameters>] Remove-Event [-SourceIdentifier] <string> [-Confirm] [-WhatIf] [<CommonParameters>]
描述
Remove-Event Cmdlet 會從目前工作階段中的事件佇列刪除事件。
此 Cmdlet 只會刪除目前位於佇列中的事件。若要取消事件註冊或取消訂閱,請使用 Unregister-Event Cmdlet。
參數
-EventIdentifier <int>
只刪除有指定的事件識別元的事件。每一個命令都需要有 EventIdentifier 或 SourceIdentifier 參數。
必要? |
true |
位置? |
1 |
預設值 |
無 |
接受管線輸入? |
true (ByPropertyName) |
接受萬用字元? |
false |
-SourceIdentifier <string>
只刪除有指定的來源識別元的事件。不允許使用萬用字元。每一個命令都需要有 EventIdentifier 或 SourceIdentifier 參數。
必要? |
true |
位置? |
1 |
預設值 |
無 |
接受管線輸入? |
false |
接受萬用字元? |
false |
-Confirm
在執行命令前先提示確認。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-WhatIf
說明執行命令時將會發生何種情況,但不會實際執行命令。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
System.Management.Automation.PSEventArgs 您也可經由管道將事件從 Get-Event 輸出至 Remove-Event。 |
輸出 |
無 這個 Cmdlet 不會產生任何輸出。 |
附註
事件、事件訂閱和事件佇列只存在於目前的工作階段中。如果關閉目前的工作階段,則會捨棄事件佇列並取消事件訂閱。
範例 1
C:\PS>remove-event -sourceIdentifier "ProcessStarted" 描述 ----------- 這個命令會從事件佇列刪除來源識別元為 "Process Started" 的事件。
範例 2
C:\PS>remove-event -eventIdentifier 30 描述 ----------- 這個命令會從事件佇列刪除事件識別碼為 30 的事件。
範例 3
C:\PS>get-event | remove-event 描述 ----------- 這個命令會從事件佇列刪除所有事件。
請參閱