ISpEventSource2::GetEventsEx (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpEventSource2::GetEventsEx

ISpEventSource2::GetEventsEx exists to return the SPEVENTEX extended event information.

  
    HRESULT GetEventsEx(
   ULONG         ulCount,
   SPEVENTEX    *pEventArray,
   ULONG        *pulFetched
);

Parameters

  • ulCount
    [in] Maximum number of events that SPEVENTEX structures can return.

  • pEventArray
    [out] Pointer to an array of SPEVENTEX structures. Each returned event is written to one of these SPEVENTEX structures.

  • pulFetched
    [out] Pointer to the number of events returned. If ulCount is one, this parameter is not required.

    The events are then removed from the queue. The events not returned are left for a future call to GetEventsEx. It is possible that by the time an application calls GetEventsEx, another thread has processed the events and there are no events to be returned. This may be the result of subsequent Notify calls.

Return values

Value
S_OK
S_FALSE
E_POINTER
FAILED(hr)