|
|
Receive an xPL message.
This function will block until either a message is received, the timeout expires, or the interrupt event becomes signalled. If a message is received before the timeout expires or the event is signalled, it is processed into an xplMsg object which is then returned. The caller is responsible for deleting the returned object through a call to xplMsg::Release. - Parameters:
-
| _hInterrupt | handle to a Windows event that when signalled causes the method to stop waiting and return. Defaults to INVALID_HANDLE_VALUE. |
| _timeout | number of milliseconds that the method should wait before returning. A value of zero will cause the function to return immediately. Passing INFINITE will disable the timeout (it will never expire). Defaults to zero. |
- Returns:
- A pointer to a new xplMsg object, or NULL if the timeout expired or the wait was interrupted.
- See also:
- xplMsg
Implements xplComms. |
