Get-EventSubscriber

项目
10/30/2009

获取当前会话中的事件订阅者。

语法

Get-EventSubscriber [-SubscriptionId] <int> [-Force] [<CommonParameters>]

Get-EventSubscriber [[-SourceIdentifier] <string>] [-Force] [<CommonParameters>]

说明

Get-EventSubscriber cmdlet 获取当前会话中的事件订阅者。

当使用 Register 事件 cmdlet 来订阅事件时，会将事件订阅者添加到 Windows PowerShell 会话中，每当发生所订阅的事件时，就会将其添加到事件队列中。要取消事件订阅，请使用 Unregister-Event cmdlet 来删除事件订阅者。

参数

-Force

获取所有事件订阅者，包括使用 Register-ObjectEvent、Register-WmiEvent 和 Register-EngineEvent 的 SupportEvent 参数隐藏的事件的订阅者。

是否为必需？	false
位置？	2
默认值
是否接受管道输入？	false
是否接受通配符？	false

-SourceIdentifier <string>

仅获取具有指定 SourceIdentifier 属性值的事件订阅者。默认情况下，Get-EventSubscriber 获取会话中的所有事件订阅者。不允许使用通配符。此参数区分大小写。

是否为必需？	false
位置？	1
默认值	所有事件订阅者
是否接受管道输入？	true (ByPropertyName)
是否接受通配符？	false

-SubscriptionId <int>

只获取指定的订阅标识符。默认情况下，Get-EventSubscriber 获取会话中的所有事件订阅者。

是否为必需？	true
位置？	1
默认值	无
是否接受管道输入？	true (ByPropertyName)
是否接受通配符？	false

<CommonParameters>

此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

无

不能通过管道将输入传递给此 cmdlet。

输出

System.Management.Automation.PSEventSubscriber

Get-EventSubscriber 返回表示每个事件订阅者的对象。

说明

New-Event cmdlet 创建自定义事件，但不生成订阅者。因此，Get-EventSubscriber cmdlet 将无法找到这些事件的订阅者对象。不过，如果使用 Register-EngineEvent cmdlet 来订阅自定义事件（以便转发事件或指定操作），则 Get-EventSubscriber 将找到 Register-EngineEvent 生成的订阅者。

事件、事件订阅和事件队列仅存在于当前会话中。如果关闭当前会话，将丢弃事件队列并取消事件订阅。

示例 1

C:\PS>$timer = New-Object Timers.Timer 

C:\PS> $timer | Get-Member -Type Event 

C:\PS> Register-ObjectEvent -inputObject $timer -EventName Elapsed -SourceIdentifier Timer.Elapsed

C:\PS> Get-EventSubscriber

C:\PS> $timer = New-Object Timers.Timer 

C:\PS> $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)

C:\PS> Register-ObjectEvent -InputObject $timer -EventName Elapsed -SourceIdentifier Timer.Elapsed

C:\PS> 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 来显示可用于计时器对象的事件。该命令使用 Get-Member cmdlet 的 Type 参数，该参数的值为 Event。

第三条命令使用 Register-ObjectEvent cmdlet 来注册计时器对象的 Elapsed 事件。

第四条命令使用 Get-EventSubscriber cmdlet 来获取 Elapsed 事件的事件订阅者。

示例 2

C:\PS>$timer  = New-Object Timers.Timer

C:\PS> $timer.Interval = 500

C:\PS> 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 ...


C:\PS> $timer.Enabled = $true

C:\PS> $subscriber = Get-EventSubcriber -sourceIdentifer Timer.Random

C:\PS> ($subscriber.action).gettype().fullname
PSEventJob

C:\PS> $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     : {}
...

C:\PS> & $subscriber.action.module {$random}
96

C:\PS> & $subscriber.action.module {$random}
23

说明
-----------
此示例演示如何在事件订阅者的 Action 属性中的 PSEventJob 对象中使用动态模块。

第一条命令使用 New-Object cmdlet 创建一个计时器对象。第二条命令将计时器间隔设置为 500（毫秒）。

第三条命令使用 Register-ObjectEvent cmdlet 注册该计时器对象的 Elapsed 事件。该命令包含处理该事件的操作。每当经过该计时器间隔时，就会引发一个事件并运行操作中的命令。在此示例中，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 变量的值。您可以使用调用运算符调用模块中的任何命令，包括未导出的命令。在此示例中，这些命令显示 Elapsed 事件发生时所生成的随机数。

有关模块的详细信息，请参阅 about_Modules。

通过