funzione lineGetMessage (tapi.h)

Articolo
03/05/2024

La funzione lineGetMessage restituisce il messaggio TAPI successivo accodato per il recapito a un'applicazione che usa il meccanismo di notifica di Gestione eventi (vedere lineInitializeEx per altri dettagli).

Sintassi

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

Parametri

hLineApp

Handle restituito da lineInitializeEx. L'applicazione deve avere impostato l'opzione LINEINITIALIZEEXOPTION_USEEVENT nel membro dwOptions della struttura LINEINITIALIZEEXPARAMS .

lpMessage

Puntatore a una struttura LINEMESSAGE . Al termine della restituzione da questa funzione, la struttura contiene il messaggio successivo accodato per il recapito all'applicazione.

dwTimeout

Intervallo di timeout, in millisecondi. La funzione restituisce se l'intervallo è trascorso, anche se non è possibile restituire alcun messaggio. Se dwTimeout è zero, la funzione controlla un messaggio in coda e restituisce immediatamente. Se dwTimeout è INFINITE, l'intervallo di timeout della funzione non scade mai.

Valore restituito

Restituisce zero se la richiesta ha esito positivo o un numero di errore negativo se si verifica un errore. I valori restituiti possibili sono:

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

Commenti

Se la funzione lineGetMessage è stata chiamata con un timeout diverso da zero e l'applicazione chiama lineShutdown in un altro thread, questa funzione restituisce immediatamente con LINEERR_INVALAPPHANDLE.

Se il timeout scade (o era zero) e non è stato possibile recuperare alcun messaggio dalla coda, la funzione restituisce con l'errore LINEERR_OPERATIONFAILED.