Get-EventSubscriber
获取当前会话中的事件订阅服务器。
语法
Get-EventSubscriber
[[-SourceIdentifier] <String>]
[-Force]
[<CommonParameters>]
Get-EventSubscriber
[-SubscriptionId] <Int32>
[-Force]
[<CommonParameters>]
说明
Get-EventSubscriber cmdlet 获取当前会话中的事件订阅者。
当你使用 Register 事件 cmdlet 订阅事件时,事件订阅服务器将添加到 Windows PowerShell 会话,而且每当引发它们时,你所订阅的事件将添加到事件队列中。 若要取消事件订阅,请使用 Unregister-Event cmdlet 删除事件订阅服务器。
示例
示例 1:获取计时器事件的事件订阅者
PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $Timer | Get-Member -Type Event
PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
PS C:\> Get-EventSubscriber
PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $Timer | Get-Member -Type Event
TypeName: System.Timers.Timer
Name MemberType Definition
---- ---------- ----------
Disposed Event System.EventHandler Disposed(System.Object, System.EventArgs)
Elapsed Event System.Timers.ElapsedEventHandler Elapsed(System.Object, System.Timers.ElapsedEventArgs) PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Elapsed
PS C:\> Get-EventSubscriber
SubscriptionId : 4
SourceObject : System.Timers.Timer
EventName : Elapsed
SourceIdentifier : Timer.Elapsed
Action :
HandlerDelegate :
SupportEvent : False
ForwardEvent : False
此示例使用 Get-EventSubscriber 命令获取计时器事件的事件订阅者。
第一个命令使用 New-Object cmdlet 创建计时器对象的实例。 它将新的计时器对象保存在 $Timer 变量中。
第二个命令使用 Get-Member cmdlet 来显示可用于计时器对象的事件。 该命令使用值为 Event 的 Get-Member cmdlet 的 Type 参数。
第三个命令使用 Register-ObjectEvent cmdlet 注册计时器对象上的已用时间事件。
第四个命令使用 Get-EventSubscriber cmdlet 获取已用事件的事件订阅者。
示例 2:在事件订阅者的 Action 属性中使用 PSEventJob 中的动态模块
PS C:\> $Timer = New-Object Timers.Timer
PS C:\> $Timer.Interval = 500
PS C:\> Register-ObjectEvent -InputObject $Timer -EventName Elapsed -SourceIdentifier Timer.Random -Action { $Random = Get-Random -Min 0 -Max 100 }
Id Name State HasMoreData Location Command
-- ---- ----- ----------- -------- -------
3 Timer.Random NotStarted False $Random = Get-Random ...
PS C:\> $Timer.Enabled = $True
PS C:\> $Subscriber = Get-EventSubscriber -SourceIdentifier Timer.Random
PS C:\> ($Subscriber.action).gettype().fullname
System.Management.Automation.PSEventJob
PS C:\> $Subscriber.action | Format-List -Property *
State : Running
Module : __DynamicModule_6b5cbe82-d634-41d1-ae5e-ad7fe8d57fe0
StatusMessage :
HasMoreData : True
Location :
Command : $random = Get-Random -Min 0 -Max 100
JobStateInfo : Running
Finished : System.Threading.ManualResetEvent
InstanceId : 88944290-133d-4b44-8752-f901bd8012e2
Id : 1
Name : Timer.Random
ChildJobs : {}
...
PS C:\> & $Subscriber.action.module {$Random}
96
PS C:\> & $Subscriber.action.module {$Random}
23
此示例演示如何在事件订阅者的 Action 属性的 PSEventJob 对象中使用动态模块。
第一个命令使用 New-Object cmdlet 创建计时器对象。 第二个命令将计时器的间隔设置为 500(毫秒)。
第三个命令使用 Register-ObjectEvent cmdlet 注册计时器对象上的已用时间事件。 该命令包含处理事件的操作。 每当计时器时间间隔过后,将引发一个事件,而且运行操作中的命令。 在这种情况下,Get-Random cmdlet 生成一个介于 0 和 100 之间的随机数,并将其保存在 $Random 变量中。 该事件的源标识符是 Timer.Random。
在 Register-ObjectEvent 命令中使用 Action 参数时,该命令返回表示该操作的 PSEventJob 对象。
第四个命令启用计时器。
第五个命令使用 Get-EventSubscriber cmdlet 获取 Timer.Random 事件的事件订阅者。 它将事件订阅服务器对象保存在 $Subscriber 变量中。
第六个命令显示事件订阅者对象的 Action 属性包含 PSEventJob 对象。 事实上,它包含 Register-ObjectEvent 命令返回的相同 PSEventJob 对象。
第七个命令使用 Format-List cmdlet 在列表中的 Action 属性中显示 PSEventJob 对象的所有属性。 结果显示 PSEventJob 对象具有 Module 属性,该属性包含实现操作的动态脚本模块。
其余命令使用调用运算符 (&) 调用模块中的命令,并显示$Random变量的值。 可以使用调用运算符来调用模块中的任何命令,包括未导出的命令。 在这种情况下,这些命令显示当已用时间事件发生时生成的随机数字。
有关模块的详细信息,请参阅 about_Modules。
参数
-Force
指示此 cmdlet 获取所有事件订阅服务器,包括使用 Register-ObjectEvent、Register-WmiEvent 和 Register-EngineEvent 的 SupportEvent 参数隐藏的事件的订阅服务器。
Type: | SwitchParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceIdentifier
指定仅获取事件订阅者的 SourceIdentifier 属性值。 默认情况下, Get-EventSubscriber 获取会话中的所有事件订阅者。 不允许使用通配符。 此参数区分大小写。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
指定此 cmdlet 获取的订阅标识符。 默认情况下, Get-EventSubscriber 获取会话中的所有事件订阅者。
Type: | Int32 |
Aliases: | Id |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
输入
None
不能通过管道将输入传递给此 cmdlet。
输出
Get-EventSubscriber 返回表示每个事件订阅者的对象。
备注
New-Event cmdlet 创建自定义事件,不生成订阅服务器。 因此, Get-EventSubscriber cmdlet 不会找到这些事件的订阅者对象。 但是,如果使用 Register-EngineEvent cmdlet 订阅自定义事件 (以转发事件或指定操作) , 则 Get-EventSubscriber 将查找 Register-EngineEvent 生成的订阅服务器。
事件、事件订阅和事件队列仅存在于当前会话中。 如果关闭当前会话,将丢弃事件队列并取消事件订阅。