lineGetMessage 函数 (tapi.h)

lineGetMessage 函数返回下一条 TAPI 消息，该消息排队等待传递到使用事件句柄通知机制的应用程序， (请参阅 lineInitializeEx 了解) 的更多详细信息。

语法

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

hLineApp

lineInitializeEx 返回的句柄。应用程序必须在 LINEINITIALIZEEXPARAMS 结构的 dwOptions 成员中设置 LINEINITIALIZEEXOPTION_USEEVENT 选项。

lpMessage

指向 LINEMESSAGE 结构的指针。成功从此函数返回后，结构将包含已排队等待传递到应用程序的下一条消息。

dwTimeout

超时间隔（以毫秒为单位）。如果间隔已过，函数将返回，即使无法返回任何消息。如果 dwTimeout 为零，函数会检查排队的消息并立即返回。如果 dwTimeout 为 INFINITE，则函数的超时间隔永远不会超过。

如果请求成功，则返回零;如果发生错误，则返回负错误号。可能的返回值为：

LINEERR_INVALAPPHANDLE、LINEERR_OPERATIONFAILED、LINEERR_INVALPOINTER、LINEERR_NOMEM。

如果已以非零超时调用 lineGetMessage 函数，并且应用程序在另一个线程上调用 lineShutdown ，则此函数会立即返回LINEERR_INVALAPPHANDLE。

如果超时 (过期或) 为零，并且无法从队列中提取任何消息，则函数将返回错误LINEERR_OPERATIONFAILED。