Remove-Event
删除事件队列中的事件。
语法
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
说明
-----------
此命令从事件队列中删除事件 ID 为 30 的事件。
示例 3
C:\PS>get-event | remove-event
说明
-----------
此命令删除事件队列中的所有事件。
另请参阅
概念
Register-ObjectEvent
Register-EngineEvent
Register-WmiEvent
Unregister-Event
Get-Event
New-Event
Remove-Event
Wait-Event