Remove-Event

Deletes events from the event queue.
Remove-Event [-SourceIdentifier*] <String> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-Event [-EventIdentifier*] <Int32> [-Confirm] [-WhatIf] [<CommonParameters>]

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 Unregister-Event cmdlet.

Parameters
-EventIdentifier <Int32>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

Specifies the event identifier for which the cmdlet deletes. An EventIdentifier or SourceIdentifier parameter is required in every command.

-SourceIdentifier <String>

  • This value is required
  • Default value is None

Specifies the source identifier for which this cmdlet deletes events from. Wildcards are not permitted. An EventIdentifier or SourceIdentifier parameter is required in every command.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.Management.Automation.PSEventArgs

You can pipe events from Get-Event to Remove-Event.

Outputs

None

The cmdlet does not generate any output.

Examples
  1. Remove an event by source identifier:
    PS C:> Remove-Event -SourceIdentifier "ProcessStarted"
    

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

  2. Remove an event by event identifier:
    PS C:> Remove-Event -EventIdentifier 30
    

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

  3. Remove all events:
    PS C:> Get-Event | Remove-Event
    

    This command deletes all events from the event queue.

Additional Notes
 Events, event subscriptions, and the event queue exist only in the current session. If you close the current 
 session, the event queue is discarded and the event subscription is canceled.
Related Links

Get-Event
New-Event
Register-EngineEvent
Register-ObjectEvent
Register-WmiEvent
Remove-Event
Unregister-Event
Wait-Event