Função phoneGetMessage (tapi.h)

Artigo
08/26/2023

A função phoneGetMessage retorna a próxima mensagem TAPI que está na fila para entrega em um aplicativo que está usando o mecanismo de notificação do Identificador de Eventos (consulte phoneInitializeEx para obter mais detalhes).

Sintaxe

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

Parâmetros

hPhoneApp

Identificador retornado por phoneInitializeEx. O aplicativo deve ter definido a opção PHONEINITIALIZEEXOPTION_USEEVENT no membro dwOptions da estrutura PHONEINITIALIZEEXPARAMS .

lpMessage

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

dwTimeout

Intervalo de tempo limite, em milissegundos. A função retornará se o intervalo passar, mesmo que nenhuma mensagem possa ser retornada. Se dwTimeout for zero, a função verificará 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 possíveis valores retornados são:

PHONEERR_INVALAPPHANDLE, PHONEERR_OPERATIONFAILED, PHONEERR_INVALPOINTER, PHONEERR_NOMEM.

Comentários

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

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