fonction phoneGetMessage (tapi.h)

Article
08/26/2023

La fonction phoneGetMessage retourne le message TAPI suivant qui est mis en file d’attente pour remise à une application qui utilise le mécanisme de notification Event Handle (voir phoneInitializeEx pour plus d’informations).

Syntaxe

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

Paramètres

hPhoneApp

Handle retourné par phoneInitializeEx. L’application doit avoir défini l’option PHONEINITIALIZEEXOPTION_USEEVENT dans le membre dwOptions de la structure PHONEINITIALIZEEXPARAMS .

lpMessage

Pointeur vers une structure PHONEMESSAGE . Une fois le retour réussi de cette fonction, la structure contient le message suivant qui avait été mis en file d’attente pour remise à l’application.

dwTimeout

Intervalle de délai d’attente, en millisecondes. La fonction retourne si l’intervalle s’écoule, même si aucun message ne peut être retourné. Si dwTimeout est égal à zéro, la fonction recherche un message mis en file d’attente et retourne immédiatement. Si dwTimeout a la valeur INFINITE, l’intervalle de délai d’attente de la fonction ne s’écoule jamais.

Valeur retournée

Retourne zéro si la demande réussit ou un nombre d’erreur négatif si une erreur se produit. Les valeurs de retour possibles sont les suivantes :

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.

Remarques

Si cette fonction a été appelée avec un délai d’expiration différent de zéro et que l’application appelle phoneShutdown sur un autre thread, cette fonction retourne immédiatement avec PHONEERR_INVALAPPHANDLE.

Si le délai d’expiration expire (ou était égal à zéro) et qu’aucun message n’a pu être extrait de la file d’attente, la fonction retourne avec l’erreur PHONEERR_OPERATIONFAILED.