Remove-Event

模組:
Microsoft.PowerShell.Utility Module

從事件隊列中刪除事件。

語法

BySource (預設值) 

Remove-Event
    [-SourceIdentifier] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdentifier 

Remove-Event
    [-EventIdentifier] <Int32>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

指令 Remove-Event 長會從當前會話的事件佇列中刪除事件。

此 cmdlet 只會刪除目前佇列中的事件。 若要取消活動報名或取消訂閱，請使用指令長（cmdlet Unregister-Event ）。

範例

範例 1：依來源識別碼移除事件

PS C:\> Remove-Event -SourceIdentifier "ProcessStarted"

此指令會從事件佇列中刪除來源識別碼為 Process Started 的事件。

範例 2：透過事件識別碼移除事件

PS C:\> Remove-Event -EventIdentifier 30

此指令會從事件佇列中刪除事件 ID 為 30 的事件。

範例三：移除所有事件

PS C:\> Get-Event | Remove-Event

此指令會刪除事件佇列中的所有事件。

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:參見

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-EventIdentifier

指定指令本刪除的事件識別碼。 每個指令中都必須有一個 EventIdentifier 或 SourceIdentifier 參數。

參數屬性

類型:Int32
預設值:None
支援萬用字元:False
不要顯示:False

參數集

ByIdentifier
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-SourceIdentifier

指定此指令本刪除事件的來源識別碼。 不允許使用萬用牌。 每個指令中都必須有一個 EventIdentifier 或 SourceIdentifier 參數。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

BySource
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:威斯康辛

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

PSEventArgs

你可以將事件從 Get-Event 這個指令匣傳到這個指令。

輸出

None

此 Cmdlet 不會傳回任何輸出。

備註

Linux 或 macOS 平台沒有事件來源。

事件、事件訂閱和事件佇列只存在於當前會話中。 如果您關閉當前的會話，事件佇列將被丟棄，事件訂閱將被取消。