Wait-Event

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

Aguarda até que um determinado evento seja levantado antes de continuar a correr.

Syntax

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 é detetado. Para cancelar a espera, pressione CTRL+C.

Esse recurso fornece uma alternativa à sondagem para um 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
  • aguardando o retorno de um evento e, em seguida, responda com uma ação

Exemplos

Exemplo 1: Aguarde o próximo evento

Este exemplo aguarda o próximo evento que é gerado.

Wait-Event

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

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

Wait-Event -SourceIdentifier "ProcessStarted"

Exemplo 3: Aguarde um evento de temporizador decorrido

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: Esperar por um evento após um tempo limite especificado

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

Wait-Event -SourceIdentifier "ProcessStarted" -Timeout 90

Parâmetros

-SourceIdentifier

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

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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 excedido, a espera termina e o prompt de comando retorna, mesmo que o evento não tenha sido gerado. Nenhuma mensagem de erro é exibida.

Type:Int32
Aliases:TimeoutSec
Position:Named
Default value:-1
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Saídas

PSEventArgs

Notas

Eventos, assinaturas de eventos e a fila de eventos existem somente na sessão atual. Se você fechar a sessão atual, a fila de eventos será descartada e a assinatura do evento será cancelada.