Wait-Event

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Ожидает определенное событие, прежде чем продолжить выполнение.

Синтаксис

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

Описание

Командлет Wait-Event приостанавливает выполнение скрипта или функции до тех пор, пока не будет вызвано определенное событие. Выполнение возобновляется после обнаружении события. Чтобы отменить ожидание, нажмите клавиши CTRL+C.

Эта функция представляет альтернативу опросу события. Он также позволяет определить ответ на событие двумя разными способами:

  • использование параметра Action подписки на событие
  • ожидание возврата события, а затем реагирование с помощью действия

Примеры

Пример 1. Ожидание следующего события

В этом примере ожидается следующее событие, которое вызывается.

Wait-Event

Пример 2. Ожидание события с указанным идентификатором источника

В этом примере ожидается следующее событие, которое вызывается и имеется исходный идентификатор ProcessStarted.

Wait-Event -SourceIdentifier "ProcessStarted"

Пример 3. Ожидание события таймера, прошедшего

В этом примере командлет используется Wait-Event для ожидания события таймера в таймере, заданном в 2000 миллисекундах.

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

Пример 4. Ожидание события после указанного времени ожидания

В этом примере ожидается до 90 секунд на следующее событие, которое вызывается и имеет исходный идентификатор ProcessStarted. Если указанное время истекает, ожидание завершается.

Wait-Event -SourceIdentifier "ProcessStarted" -Timeout 90

Параметры

-SourceIdentifier

Указывает исходный идентификатор, который этот командлет ожидает событий. По умолчанию Wait-Event ожидает любое событие.

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

-Timeout

Указывает максимальное время в секундах, ожидающее Wait-Event возникновения события. Значение по умолчанию, -1, обозначает неопределенное время ожидания. Время начинается при отправке Wait-Event команды.

Если указанное время ожидания превышено, ожидание прекращается и возвращается командная строка, даже если событие не возникло. Сообщение об ошибке не отображается.

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

Входные данные

String

Выходные данные

PSEventArgs

Примечания

События, подписки на события и очередь событий существуют только в текущем сеансе. Если закрыть текущий сеанс, очередь событий удаляется, а подписка на событие отменяется.