Función lineGetMessage (tapi.h)

Artículo
03/02/2024

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

Sintaxis

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

Parámetros

hLineApp

Identificador devuelto por lineInitializeEx. La aplicación debe haber establecido la opción LINEINITIALIZEEXOPTION_USEEVENT en el miembro dwOptions de la estructura LINEINITIALIZEEXPARAMS .

lpMessage

Puntero a una estructura LINEMESSAGE . 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:

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

Comentarios

Si se ha llamado a la función lineGetMessage con un tiempo de espera distinto de cero y la aplicación llama a lineShutdown en otro subproceso, esta función devuelve inmediatamente con LINEERR_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 LINEERR_OPERATIONFAILED.