Share via

Wait-Event

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Espera a que se genere un evento determinado antes de continuar con la ejecución.

Syntax

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

Description

El Wait-Event cmdlet suspende la ejecución de un script o función hasta que se genere un evento determinado. Cuando el evento se detecta, se reanuda la ejecución. Para cancelar la espera, presione CTRL+C.

Esta característica proporciona una alternativa a sondear eventos. También permite determinar la respuesta a un evento de dos maneras diferentes:

  • uso del parámetro Action de la suscripción de eventos
  • esperando a que un evento devuelva y, a continuación, responda con una acción

Ejemplos

Ejemplo 1: Esperar al siguiente evento

En este ejemplo se espera el siguiente evento que se genera.

Wait-Event

Ejemplo 2: Esperar un evento con un identificador de origen especificado

En este ejemplo se espera el siguiente evento que se genera y que tiene un identificador de origen de ProcessStarted.

Wait-Event -SourceIdentifier "ProcessStarted"

Ejemplo 3: Esperar un evento transcurrido del temporizador

En este ejemplo se usa el Wait-Event cmdlet para esperar un evento de temporizador en un temporizador establecido para 2000 milisegundos.

$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      :

Ejemplo 4: Esperar un evento después de un tiempo de espera especificado

Este ejemplo espera hasta 90 segundos para el siguiente evento que se genera y que tiene un identificador de origen de ProcessStarted. Si se agota el tiempo especificado, la espera termina.

Wait-Event -SourceIdentifier "ProcessStarted" -Timeout 90

Parámetros

-SourceIdentifier

Especifica el identificador de origen que este cmdlet espera para eventos. De forma predeterminada, Wait-Event espera cualquier evento.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

Especifica el tiempo máximo, en segundos, que espera a que Wait-Event se produzca el evento. Con el valor predeterminado, -1, se espera indefinidamente. El tiempo se inicia al enviar el Wait-Event comando.

Si se supera el tiempo especificado, la espera termina y el símbolo del sistema regresa aunque no se generara el evento. No se muestra ningún mensaje de error.

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

Entradas

String

Salidas

PSEventArgs

Notas

La cola de eventos, las suscripciones de eventos y los eventos solo existen en la sesión actual. Si la cierra, la cola de eventos se descartará y la suscripción al evento se cancelará.