phoneGetMessage

  • Article

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

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 Values

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

OS Versions: Windows CE 3.0 and later.
Header: Tapi.h.
Link Library: Coredll.lib.

See Also

phoneInitializeEx | phoneShutdown | PHONEINITIALIZEEXPARAMS | PHONEMESSAGE

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.