ISpAudio::EventHandle
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method returns a Win32 event handle that applications can use to wait for status changes in the I/O stream. The handle can use one of the various Win32 wait functions, such as WaitForSingleObject or WaitForMultipleObjects.
For read streams, set the event when there is data available to read and reset it whenever there is no available data. For write streams, set the event when all the data has been written to the device, and reset it at any time when there is still data available to be played.
The caller should not close the returned handle, nor ever use the event handle after calling Release on the audio object. The audio device will close the handle on the final release of the object.
Syntax
HANDLE EventHandle(void);
Parameters
None.
Return Value
The following table shows the possible return value.
| Value | Description |
|---|---|
HANDLE |
Returns valid event handle. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |