phoneGetMessage
The phoneGetMessage
function returns the next TAPI message that is queued for delivery to an
application that is using the Event Handle notification mechanism (see phoneInitializeEx
for further details).
LONG phoneGetMessage(
|
HPHONEAPP hPhoneApp, |
|
|
LPPHONEMESSAGE lpMessage, |
|
|
DWORD dwTimeout |
|
|
); |
|
Parameters
hPhoneApp
The handle
returned by phoneInitializeEx. The application must have set the
PHONEINITIALIZEEXOPTION_USEEVENT option in the dwOptions field of the PHONEINITIALIZEEXPARAMS structure.
lpMessage
A pointer to
a PHONEMESSAGE
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:
PHONEERR_INVALAPPHANDLE,
PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.
Remarks
If this
function has been called with a non-zero timeout and the application calls phoneShutdown on another thread, this
function will return immediately with PHONEERR_INVALAPPHANDLE.
If the
timeout expires (or was zero) and no message could be fetched from the queue,
the function returns with the error PHONEERR_OPERATIONFAILED.
See Also