New-Event
Cria um novo evento.
Sintaxe
New-Event
[-SourceIdentifier] <String>
[[-Sender] <PSObject>]
[[-EventArguments] <PSObject[]>]
[[-MessageData] <PSObject>]
[<CommonParameters>]
Description
O cmdlet New-Event cria um novo evento personalizado.
Você pode usar eventos personalizados para notificar os usuários sobre alterações de estado em seu programa e qualquer alteração que seu programa possa detectar, incluindo condições de hardware ou sistema, status do aplicativo, status do disco, status da rede ou a conclusão de um trabalho em segundo plano.
Eventos personalizados são adicionados automaticamente à fila de eventos em sua sessão sempre que são gerados; você não precisa se inscrever neles. No entanto, se você quiser encaminhar um evento para a sessão local ou especificar uma ação para responder ao evento, use o cmdlet Register-EngineEvent para assinar o evento personalizado.
Quando você assina um evento personalizado, o assinante do evento é adicionado à sua sessão. Se você cancelar a assinatura do evento usando o cmdlet Unregister-Event, o assinante do evento e o evento personalizado serão excluídos da sessão. Se você não assinar o evento personalizado, para excluir o evento, deverá alterar as condições do programa ou fechar a sessão do Windows PowerShell.
Exemplos
Exemplo 1: criar um novo evento na fila de eventos
PS C:\> New-Event -SourceIdentifier Timer -Sender windows.timer -MessageData "Test"
Esse comando cria um novo evento na fila de eventos do Windows PowerShell.
Ele usa um objeto
Exemplo 2: gerar um evento em resposta a outro evento
PS C:\> function Enable-ProcessCreationEvent
{
$Query = New-Object System.Management.WqlEventQuery "__InstanceCreationEvent", (New-Object TimeSpan 0,0,1), "TargetInstance isa 'Win32_Process'"
$ProcessWatcher = New-Object System.Management.ManagementEventWatcher $Query
$Identifier = "WMI.ProcessCreated"
Register-ObjectEvent $ProcessWatcher "EventArrived" -SupportEvent $Identifier -Action
{
[void] (New-Event -SourceID "PowerShell.ProcessCreated" -Sender $Args[0] -EventArguments $Args[1].SourceEventArgs.NewEvent.TargetInstance)
}
}
Esta função de exemplo usa o cmdlet
Como os eventos que novos eventos são adicionados automaticamente à fila do Windows PowerShellevent, você não precisa se registrar para esse evento.
Parâmetros
-EventArguments
Especifica um objeto que contém opções para o evento.
Tipo: | PSObject[] |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-MessageData
Especifica dados adicionais associados ao evento. O valor desse parâmetro aparece na propriedade MessageData do objeto de evento.
Tipo: | PSObject |
Cargo: | 3 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Sender
Especifica o objeto que aciona o evento. O padrão é o mecanismo do Windows PowerShell.
Tipo: | PSObject |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-SourceIdentifier
Especifica um nome para o novo evento. Esse parâmetro é necessário e deve ser exclusivo na sessão.
O valor desse parâmetro aparece na propriedade SourceIdentifier dos eventos.
Tipo: | String |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
None
Não é possível redirecionar a entrada para este cmdlet.
Saídas
Observações
O novo evento personalizado, a assinatura do evento e a fila de eventos existem apenas na sessão atual. Se você fechar a sessão atual, a fila de eventos será descartada e a assinatura do evento será cancelada.