lineGetMessage-Funktion (tapi.h)

Artikel
03/02/2024

Die lineGetMessage-Funktion gibt die nächste TAPI-Nachricht zurück, die für die Übermittlung an eine Anwendung in die Warteschlange eingereiht wird, die den Event Handle-Benachrichtigungsmechanismus verwendet (weitere Details finden Sie unter lineInitializeEx ).

Syntax

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

Parameter

hLineApp

Von lineInitializeEx zurückgegebenes Handle. Die Anwendung muss die Option LINEINITIALIZEEXOPTION_USEEVENT im dwOptions-Element der LINEINITIALIZEEXPARAMS-Struktur festgelegt haben.

lpMessage

Zeiger auf eine LINEMESSAGE-Struktur . Nach erfolgreicher Rückgabe von dieser Funktion enthält die -Struktur die nächste Nachricht, die für die Übermittlung an die Anwendung in die Warteschlange eingereiht wurde.

dwTimeout

Timeoutintervall in Millisekunden. Die Funktion gibt zurück, wenn das Intervall verstrichen ist, auch wenn keine Nachricht zurückgegeben werden kann. Wenn dwTimeout null ist, sucht die Funktion nach einer Nachricht in der Warteschlange und gibt sofort zurück. Wenn dwTimeout INFINITE ist, vergeht das Timeoutintervall der Funktion nie.

Rückgabewert

Gibt null zurück, wenn die Anforderung erfolgreich ist, oder eine negative Fehlernummer, wenn ein Fehler auftritt. Mögliche Rückgabewerte sind:

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

Hinweise

Wenn die lineGetMessage-Funktion mit einem Timeout ungleich Null aufgerufen wurde und die Anwendung lineShutdown für einen anderen Thread aufruft, wird diese Funktion sofort mit LINEERR_INVALAPPHANDLE zurückgegeben.

Wenn das Timeout abläuft (oder null war) und keine Nachricht aus der Warteschlange abgerufen werden konnte, gibt die Funktion mit dem Fehler LINEERR_OPERATIONFAILED zurück.