Microsoft Speech Platform
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 | Description |
|---|---|
| S_OK | Function completed successfully. |
| S_FALSE | The operation timed-out. |
| SPERR_ALREADY_INITIALIZED | This event source has been initialized to use a notification mechanism other than a Win32 event. It was unable to re-initialize the notification. |
| FAILED (hr) | Appropriate error message. |
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.