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

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

Синтаксис

LONG lineGetMessage(
  HLINEAPP      hLineApp,
  LPLINEMESSAGE lpMessage,
  DWORD         dwTimeout
);

Параметры

hLineApp

Дескриптор возвращается lineInitializeEx. Приложение должно задать параметр LINEINITIALIZEEXOPTION_USEEVENT в элементе dwOptions структуры LINEINITIALIZEEXPARAMS .

lpMessage

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

dwTimeout

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

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

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

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER LINEERR_NOMEM.

Комментарии

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

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

Требования

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

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

LINEINITIALIZEEXPARAMS

LINEMESSAGE

lineInitializeEx

lineShutdown