ISpNotifySource::WaitForNotifyEvent (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpNotifySource::WaitForNotifyEvent

ISpNotifySource::WaitForNotifyEvent is a blocking call that waits on a Win32 event handle for a SAPI notification.

  
    HRESULT WaitForNotifyEvent(
   DWORD   dwMilliseconds
);

Parameters

  • dwMilliseconds
    [in] Number of milliseconds for the timeout on a blocking call. If set to INFINITE, there is no timeout.

Return values

Value
S_OK
S_FALSE
SPERR_ALREADY_INITIALIZED
FAILED (hr)

Remarks

A blocking call returns when a SAPI notification has fired, a timeout has passed, or the initialized Win32 event object has signaled. Calling this method will automatically initialize the event source to use an event handle if no other notification mechanism has been initialized.