Funzione phoneGetMessage (tapi.h)

Articolo
03/02/2024

La funzione phoneGetMessage restituisce il messaggio TAPI successivo che viene accodato per il recapito a un'applicazione che usa il meccanismo di notifica Di gestione eventi (vedere phoneInitializeEx per altri dettagli).

Sintassi

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

Parametri

hPhoneApp

Handle restituito da phoneInitializeEx. L'applicazione deve avere impostato l'opzione PHONEINITIALIZEEXOPTION_USEEVENT nel membro dwOptions della struttura PHONEINITIALIZEEXPARAMS .

lpMessage

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

dwTimeout

Intervallo di timeout, espresso in millisecondi. La funzione restituisce se l'intervallo è trascorso, anche se non è possibile restituire alcun messaggio. Se dwTimeout è zero, la funzione verifica la presenza di 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 negativo se si verifica un errore. I valori restituiti possibili sono:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER PHONEERR_NOMEM.

Commenti

Se questa funzione è stata chiamata con un timeout diverso da zero e l'applicazione chiama phoneShutdown su un altro thread, questa funzione restituisce immediatamente con PHONEERR_INVALAPPHANDLE.

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