phoneGetMessage (Compact 2013)

3/26/2014

This 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).

Syntax

LONG WINAPI phoneGetMessage(
  HPHONEAPP hPhoneApp,
  LPPHONEMESSAGE lpMessage,
  DWORD dwTimeout
);

Parameters

• hPhoneApp
  Handle returned by the phoneInitializeEx function. The application must have set the PHONEINITIALIZEEXOPTION_USEEVENT option in the dwOptions member of the PHONEINITIALIZEEXPARAMS structure.

• lpMessage
  Pointer to a PHONEMESSAGE structure. Upon successful return from this function, the structure contains the next message that had been queued for delivery to the application.

• dwTimeout
  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 Value

Zero indicates success. A negative error number indicates that an error occurred. The following table shows the return values for this function.

Value	Description
PHONEERR_INVALAPPHANDLE	The application called the phoneShutdown function. While this function has been called with a nonzero time-out.
PHONEERR_INVALPOINTER	The pointer is invalid.
PHONEERR_OPERATIONFAILED	The time-out expired (or was zero) and no message could be fetched from the queue.
PHONEERR_NOMEM	Not enough memory is available.

Remarks

If this function has been called with a nonzero time-out and the application calls phoneShutdown on another thread, this function returns immediately with PHONEERR_INVALAPPHANDLE.

If the time-out expires (or was zero) and no message could be fetched from the queue, the function returns with the error PHONEERR_OPERATIONFAILED.

Requirements

Header	tapi.h
Library	TAPI32.dll

See Also

Reference

TAPI Phone Device Functions
phoneInitializeEx
phoneShutdown
PHONEINITIALIZEEXPARAMS
PHONEMESSAGE