Compartir a través de

Wait-Event

Módulo:
Microsoft.PowerShell.Utility Module

Espera hasta que se genere un evento determinado antes de continuar ejecutándose.

Sintaxis

Default (valor predeterminado) 

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

Description

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

Esta característica proporciona una alternativa al sondeo de un evento. También permite determinar la respuesta a un evento de dos maneras diferentes: mediante el uso del Action parámetro de la suscripción de eventos y esperando a que un evento devuelva y, a continuación, responda con una acción.

Ejemplos

Ejemplo 1: Esperar al siguiente evento

PS C:\> Wait-Event

Este comando espera el siguiente evento que se genera.

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

PS C:\> Wait-Event -SourceIdentifier "ProcessStarted"

Este comando espera el siguiente evento que se genera y que tiene un identificador de origen de ProcessStarted.

Ejemplo 3: Esperar un evento transcurrido del temporizador

PS C:\> $Timer.Interval = 2000
PS C:\> $Timer.Autoreset = $False
PS C:\> $Timer.Enabled = $True; Wait-Event Timer.Elapsed
# After 2 seconds
EventIdentifier  : 12
Sender           : System.Timers.Timer
SourceEventArgs  : System.Timers.ElapsedEventArgs
SourceArgs       : {System.Timers.Timer, System.Timers.ElapsedEventArgs}
SourceIdentifier : Timer.Elapsed
TimeGenerated    : 6/10/2008 3:24:18 PM
MessageData      :
ForwardEvent     : False

Este comando usa el cmdlet wait-Event para esperar un evento de temporizador en un temporizador establecido para 2000 milisegundos.

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

PS C:\> Wait-Event -SourceIdentifier "ProcessStarted" -Timeout 90

Este comando espera hasta 90 segundos para el siguiente evento que se genera y que tiene un identificador de origen de "ProcessStarted". Si expira el tiempo especificado, finaliza la espera.

Parámetros

-SourceIdentifier

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Timeout

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

Si se supera el tiempo especificado, finaliza la espera y el símbolo del sistema devuelve, incluso si no se ha generado el evento. No se muestra ningún mensaje de error.

Propiedades de parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:TimeoutSec

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

String

Salidas

PSEventArgs

Notas

  • Los eventos, las suscripciones de eventos y la cola de eventos solo existen en la sesión actual. Si se cierra la sesión actual, se descarta la fila de eventos y se cancela la suscripción al evento.