Wait-Event

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Aguarda até que um determinado evento seja gerado antes de continuar a executar.

Sintaxe

Wait-Event
    [[-SourceIdentifier] <String>]
    [-Timeout <Int32>]
    [<CommonParameters>]

Description

O Wait-Event cmdlet suspende a execução de um script ou função até que um evento específico seja gerado. A execução é retomada quando o evento é detectado. Para cancelar a espera, pressione CTRL+C.

Esse recurso fornece uma alternativa às sondagens de evento. Ele também permite que você determine a resposta a um evento de duas maneiras diferentes:

  • usando o parâmetro Action da assinatura do evento
  • aguardar o retorno de um evento e, em seguida, responder com uma ação

Exemplos

Exemplo 1: Aguardar o próximo evento

Este exemplo aguarda o próximo evento gerado.

Wait-Event

Exemplo 2: Aguardar um evento com um identificador de origem especificado

Este exemplo aguarda o próximo evento gerado e que tem um identificador de origem de ProcessStarted.

Wait-Event -SourceIdentifier "ProcessStarted"

Exemplo 3: Aguardar um evento decorrido do temporizador

Este exemplo usa o Wait-Event cmdlet para aguardar um evento de temporizador em um temporizador definido para 2000 milissegundos.

$Timer = New-Object Timers.Timer
$objectEventArgs = @{
    InputObject = $Timer
    EventName = 'Elapsed'
    SourceIdentifier = 'Timer.Elapsed'
}
Register-ObjectEvent @objectEventArgs
$Timer.Interval = 2000
$Timer.Autoreset = $False
$Timer.Enabled = $True
Wait-Event Timer.Elapsed

ComputerName     :
RunspaceId       : bb560b14-ff43-48d4-b801-5adc31bbc6fb
EventIdentifier  : 1
Sender           : System.Timers.Timer
SourceEventArgs  : System.Timers.ElapsedEventArgs
SourceArgs       : {System.Timers.Timer, System.Timers.ElapsedEventArgs}
SourceIdentifier : Timer.Elapsed
TimeGenerated    : 4/23/2020 2:30:37 PM
MessageData      :

Exemplo 4: Aguardar um evento após um tempo limite especificado

Este exemplo aguarda até 90 segundos pelo próximo evento gerado e que tem um identificador de origem de ProcessStarted. Se o tempo especificado expirar, a espera terminará.

Wait-Event -SourceIdentifier "ProcessStarted" -Timeout 90

Parâmetros

-SourceIdentifier

Especifica o identificador de origem que esse cmdlet aguarda para eventos. Por padrão, Wait-Event aguarda qualquer evento.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Timeout

Especifica o tempo máximo, em segundos, que Wait-Event aguarda a ocorrência do evento. O padrão, -1, aguarda indefinidamente. O tempo começa quando você envia o Wait-Event comando.

Se o tempo especificado for ultrapassado, a espera terminará e o prompt de comando retornará, ainda que o evento não tenha sido ativado. Nenhuma mensagem de erro é exibida.

Tipo:Int32
Aliases:TimeoutSec
Cargo:Named
Valor padrão:-1
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

Saídas

PSEventArgs

Observações

Eventos, assinaturas de 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 inscrição do evento será cancelada.