Wait-Event

Attend qu'un événement particulier soit déclenché avant de poursuivre l'exécution.

Syntaxe

Wait-Event [[-SourceIdentifier] <string>] [-Timeout <int>] [<CommonParameters>]

Description

L'applet de commande Wait-Event interrompt l'exécution d'un script ou d'une fonction jusqu'à ce qu'un événement spécifique soit déclenché. L'exécution reprend lorsque l'événement est détecté. Pour annuler l'attente, appuyez sur CTRL+C.

Cette fonctionnalité fournit une alternative à l'appel d'un événement. Elle vous permet également de déterminer la réponse à un événement de deux façons différentes : en utilisant le paramètre Action de l'abonnement aux événements, et en attendant un événement à retourner puis en répondant avec une action.

Paramètres

-SourceIdentifier <string>

Attend uniquement les événements possédant l'identificateur source spécifié. Par défaut, Wait-Event attend tous les événements.

Obligatoire ?	false
Position ?	1
Valeur par défaut	All events
Accepter l'entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-Timeout <int>

Détermine la durée maximale, en secondes, pendant laquelle Wait-Event attend que l'événement se produise. La valeur par défaut, -1, attend indéfiniment. Le calcul du temps démarre lorsque vous envoyez la commande Wait-Event.

Si la durée spécifiée est dépassée, l'attente se termine et l'invite de commandes réapparaît, même si l'événement n'a pas été déclenché. Aucun message d'erreur n'est affiché.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.

Entrées et sorties

Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.

Entrées

System.String

Sorties

System.String

Remarques

Les événements, les abonnements aux événements et la file d'attente d'événements existent uniquement dans la session active. Si vous fermez la session active, la file d'attente des événements est ignorée et l'abonnement aux événements est annulé.

Exemple 1

C:\PS>wait-event

Description
-----------
Cette commande attend l'événement suivant déclenché.

Exemple 2

C:\PS>wait-event -sourceIdentifier "ProcessStarted"

Description
-----------
Cette commande attend l'événement suivant déclenché possédant l'identificateur source « ProcessStarted ».

Exemple 3

C:\PS>$timer.Interval = 2000 
C:\PS> $timer.Autoreset = $false 
C:\PS> $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

Description
-----------
Cette commande utilise l'applet de commande Wait-Event pour attendre un événement minuteur sur un minuteur défini sur 2 000 millisecondes.

Exemple 4

C:\PS>wait-event -sourceIdentifier "ProcessStarted" -timeout 90

Description
-----------
Cette commande attend jusqu'à 90 secondes l'événement suivant déclenché possédant l'identificateur source « ProcessStarted ». Si la durée spécifiée expire, l'attente se termine.