ISpRecoContext::GetVoicePurgeEvent
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 gets the SR engine events that stop audio output, and purges the current speaking queue. The events are set by ISpRecoContext::SetVoicePurgeEvent.
Syntax
HRESULT GetVoicePurgeEvent(
ULONGLONG* pullEventInterest
);
Parameters
- pullEventInterest
[out] Pointer to a set of flags indicating event interests, which are members of the SR engine event set. Possible events are defined by the SPEVENTENUM enumeration.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_POINTER |
pullEventInterest is invalid or bad. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |