lineGetMessage
The lineGetMessage
function returns the next TAPI message that is queued for delivery to an
application that is using the Event Handle notification mechanism (see lineInitializeEx for further details).
LONG lineGetMessage(
|
HLINEAPP hLineApp, |
|
|
LPLINEMESSAGE lpMessage, |
|
|
DWORD dwTimeout |
|
|
); |
|
Parameters
hLineApp
The handle
returned by lineInitializeEx. The application must have set the
LINEINITIALIZEEXOPTION_USEEVENT option in the dwOptions member of the LINEINITIALIZEEXPARAMS structure.
lpMessage
A pointer to
a LINEMESSAGE
structure. Upon successful return from this function, the structure will
contain the next message which had been queued for delivery to the application.
dwTimeout
The time-out
interval, in milliseconds. The function returns if the interval elapses, even
if no message can be returned. If dwTimeout is zero, the function checks
for a queued message and returns immediately. If dwTimeout is INFINITE,
the function's time-out interval never elapses.
Return Values
Returns zero
if the request is successful or a negative error number if an error has
occurred. Possible return values are:
LINEERR_INVALAPPHANDLE,
LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.
Remarks
If the lineGetMessage
function has been called with a non-zero timeout and the application calls lineShutdown
on another thread, this function will return immediately with
LINEERR_INVALAPPHANDLE.
If the
timeout expires (or was zero) and no message could be fetched from the queue,
the function returns with the error LINEERR_OPERATIONFAILED.
See Also