powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Event



NAME
Remove-Event

SYNOPSIS
Deletes events from the event queue.

SYNTAX
Remove-Event [-EventIdentifier] [-Confirm] [-WhatIf] []

Remove-Event [-SourceIdentifier] [-Confirm] [-WhatIf] []


DESCRIPTION
The Remove-Event cmdlet deletes events from the event queue in the current session.

This cmdlet deletes only the events currently in the queue. To cancel event registrations or unsubscribe, use the U
nregister-Event cmdlet.


PARAMETERS
-EventIdentifier
Deletes only the event with the specified event identifier. An EventIdentifier or SourceIdentifier parameter is
required in every command.

Required? true
Position? 1
Default value None
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-SourceIdentifier
Deletes only the events with the specified source identifier. Wildcards are not permitted. An EventIdentifier o
r SourceIdentifier parameter is required in every command.

Required? true
Position? 1
Default value None
Accept pipeline input? false
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.PSEventArgs
You can pipe events from Get-Event to Remove-Event.


OUTPUTS
None
The cmdlet does not generate any output.


NOTES


Events, event subscriptions, and the event queue exist only in the current session. If you close the current se
ssion, the event queue is discarded and the event subscription is canceled.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>remove-event -sourceIdentifier "ProcessStarted"


Description
-----------
This command deletes events with a source identifier of "Process Started" from the event queue.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>remove-event -eventIdentifier 30


Description
-----------
This command deletes the event with an event ID of 30 from the event queue.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-event | remove-event


Description
-----------
This command deletes all events from the event queue.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=135247
Register-ObjectEvent
Register-EngineEvent
Register-WmiEvent
Unregister-Event
Get-Event
New-Event
Remove-Event
Wait-Event