Función phoneGetMessage (tapi.h)

Artículo
03/08/2023

La función phoneGetMessage devuelve el siguiente mensaje TAPI que se pone en cola para su entrega a una aplicación que usa el mecanismo de notificación de identificador de eventos (consulte phoneInitializeEx para obtener más detalles).

Sintaxis

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

Parámetros

hPhoneApp

Identificador devuelto por phoneInitializeEx. La aplicación debe haber establecido la opción PHONEINITIALIZEEXOPTION_USEEVENT en el miembro dwOptions de la estructura PHONEINITIALIZEEXPARAMS .

lpMessage

Puntero a una estructura PHONEMESSAGE . Tras la devolución correcta de esta función, la estructura contiene el siguiente mensaje que se había puesto en cola para la entrega a la aplicación.

dwTimeout

Intervalo de tiempo de espera, en milisegundos. La función devuelve si transcurre el intervalo, incluso si no se puede devolver ningún mensaje. Si dwTimeout es cero, la función comprueba si hay un mensaje en cola y devuelve inmediatamente. Si dwTimeout es INFINITE, el intervalo de tiempo de espera de la función nunca transcurre.

Valor devuelto

Devuelve cero si la solicitud se realiza correctamente o un número de error negativo si se produce un error. Los valores devueltos posibles son:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.

Comentarios

Si se ha llamado a esta función con un tiempo de espera distinto de cero y la aplicación llama a phoneShutdown en otro subproceso, esta función devuelve inmediatamente con PHONEERR_INVALAPPHANDLE.

Si el tiempo de espera expira (o era cero) y no se pudo capturar ningún mensaje de la cola, la función devuelve con el error PHONEERR_OPERATIONFAILED.