Função lineGetMessage (tapi.h)

Artigo
03/05/2024

A função lineGetMessage retorna a próxima mensagem TAPI enfileirada para entrega em um aplicativo que está usando o mecanismo de notificação do Identificador de Evento (consulte lineInitializeEx para obter mais detalhes).

Sintaxe

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

Parâmetros

hLineApp

Identificador retornado por lineInitializeEx. O aplicativo deve ter definido a opção LINEINITIALIZEEXOPTION_USEEVENT no membro dwOptions da estrutura LINEINITIALIZEEXPARAMS .

lpMessage

Ponteiro para uma estrutura LINEMESSAGE . Após o retorno bem-sucedido dessa função, a estrutura contém a próxima mensagem que havia sido enfileirada para entrega ao aplicativo.

dwTimeout

Intervalo de tempo limite, em milissegundos. A função retornará se o intervalo decorrer, mesmo que nenhuma mensagem possa ser retornada. Se dwTimeout for zero, a função verificará se há uma mensagem enfileirada e retornará imediatamente. Se dwTimeout for INFINITE, o intervalo de tempo limite da função nunca será decorrido.

Retornar valor

Retornará zero se a solicitação for bem-sucedida ou um número de erro negativo se ocorrer um erro. Os valores retornados possíveis são:

LINEERR_INVALAPPHANDLE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_NOMEM.

Comentários

Se a função lineGetMessage tiver sido chamada com um tempo limite diferente de zero e o aplicativo chamar lineShutdown em outro thread, essa função retornará imediatamente com LINEERR_INVALAPPHANDLE.

Se o tempo limite expirar (ou for zero) e nenhuma mensagem puder ser buscada da fila, a função retornará com o erro LINEERR_OPERATIONFAILED.