fonction lineGetMessage (tapi.h)

Article
03/02/2024

La fonction lineGetMessage 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 lineInitializeEx pour plus d’informations).

Syntaxe

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

Paramètres

hLineApp

Handle retourné par lineInitializeEx. L’application doit avoir défini l’option LINEINITIALIZEEXOPTION_USEEVENT dans le membre dwOptions de la structure LINEINITIALIZEEXPARAMS .

lpMessage

Pointeur vers une structure LINEMESSAGE . Une fois le retour réussi de cette fonction, la structure contient le message suivant qui avait été mis en file d’attente pour la 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 en file d’attente et retourne immédiatement. Si dwTimeout est INFINITE, l’intervalle de délai d’attente de la fonction ne s’écoule jamais.

Valeur retournée

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

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

Remarques

Si la fonction lineGetMessage a été appelée avec un délai d’attente non nul et que l’application appelle lineShutdown sur un autre thread, cette fonction retourne immédiatement avec LINEERR_INVALAPPHANDLE.

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