phoneGetMessage-Funktion (tapi.h)

Artikel
08/26/2023

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

Syntax

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

Parameter

hPhoneApp

Von phoneInitializeEx zurückgegebenes Handle. Die Anwendung muss die option PHONEINITIALIZEEXOPTION_USEEVENT im dwOptions-Element der PHONEINITIALIZEEXPARAMS-Struktur festgelegt haben.

lpMessage

Zeiger auf eine PHONEMESSAGE-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:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.

Hinweise

Wenn diese Funktion mit einem Timeout ungleich null aufgerufen wurde und die Anwendung phoneShutdown für einen anderen Thread aufruft, wird diese Funktion sofort mit PHONEERR_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 PHONEERR_OPERATIONFAILED zurück.