Функция phoneGetMessage (tapi.h)

Функция phoneGetMessage возвращает следующее сообщение TAPI, которое поставлено в очередь для доставки в приложение, использующее механизм уведомлений обработчика событий (дополнительные сведения см. в разделе phoneInitializeEx ).

Синтаксис

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

Параметры

hPhoneApp

Дескриптор, возвращенный phoneInitializeEx. Приложение должно задать параметр PHONEINITIALIZEEXOPTION_USEEVENT в элементе dwOptions структуры PHONEINITIALIZEEXPARAMS .

lpMessage

Указатель на структуру PHONEMESSAGE . При успешном возвращении из этой функции структура содержит следующее сообщение, которое было поставлено в очередь для доставки в приложение.

dwTimeout

Интервал времени ожидания в миллисекундах. Функция возвращает значение , если истекает интервал, даже если сообщение не может быть возвращено. Если значение dwTimeout равно нулю, функция проверяет наличие сообщения в очереди и немедленно возвращает его. Если параметр dwTimeout имеет значение INFINITE, интервал времени ожидания функции никогда не истекает.

Возвращаемое значение

Возвращает ноль, если запрос выполнен успешно, или отрицательный номер ошибки при возникновении ошибки. Возможные возвращаемые значения:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER PHONEERR_NOMEM.

Комментарии

Если эта функция была вызвана с ненулевым временем ожидания и приложение вызывает phoneShutdown в другом потоке , эта функция немедленно возвращает PHONEERR_INVALAPPHANDLE.

Если время ожидания истекло (или равно нулю) и сообщение не может быть получено из очереди, функция возвращает ошибку PHONEERR_OPERATIONFAILED.

Требования

Требование	Значение
Целевая платформа	Windows
Header	tapi.h
Библиотека	Tapi32.lib
DLL	Tapi32.dll

См. также раздел

PHONEINITIALIZEEXPARAMS

PHONEMESSAGE

phoneInitializeEx

phoneShutdown