Share via

ISpNotifySource::WaitForNotifyEvent

  • Article

This method is a blocking call that waits on a Win32 event handle for a SAPI notification. 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.

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

The following table shows the possible 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 some notification mechanism other than a Win32 event. It was unable to re-initialize the notification.
FAILED(hr) Appropriate error message.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpNotifySource | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.