 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
Retrieves the next notification event.
HRESULT GetEvent( long * lEventCode , long * lParam1 , long * lParam2 , long msTimeout );
Parameters
- lEventCode
- [out] Next event notification.
- lParam1
- [out] First parameter of the event.
- lParam2
- [out] Second parameter of the event.
- msTimeout
- [in] Time, in milliseconds, to wait before assuming that there
are no events.
Return Values
Returns an HRESULTvalue that depends on the implementation of the interface. If the time-out is zero and no event is waiting, or if the time-out elapses before an event appears, this method returns E_ABORT.
Remarks
The application can pass a time-out value of INFINITE to indicate that the method should block until there is an event; however, applications should avoid using INFINITE. Threads cannot process any messages while waiting in GetEvent. If you call GetEventfrom the thread that processes Windows messages, specify only small wait times on the call in order to remain responsive to user input. This is most important when streaming data from a source such as the Internet, because state transitions can take significantly more time to complete.
After calling GetEvent, applications should always call FreeEventParamsto release any resource associated with the event.
For a list of notification codes and event parameter values, see Event Notification Codes.