Função lineGetAgentStatusW (tapi.h)

Artigo
03/05/2024

A função lineGetAgentStatus obtém a status relacionada ao agente no endereço especificado.

Sintaxe

LONG lineGetAgentStatusW(
  HLINE             hLine,
  DWORD             dwAddressID,
  LPLINEAGENTSTATUS lpAgentStatus
);

Parâmetros

hLine

Manipule para o dispositivo de linha aberta.

dwAddressID

Endereço no dispositivo de linha aberta cujo agente status deve ser consultado. Um identificador de endereço está permanentemente associado a um endereço; o identificador permanece constante entre as atualizações do sistema operacional.

lpAgentStatus

Ponteiro para uma estrutura de tamanho variável do tipo LINEAGENTSTATUS. Após a conclusão bem-sucedida da solicitação, essa estrutura é preenchida com informações de status do agente. Antes de chamar lineGetAgentStatus, o aplicativo deve definir o membro dwTotalSize dessa estrutura para indicar a quantidade de memória disponível para TAPI para retornar informações.

Nota Se os parâmetros de tamanho na estrutura não estiverem corretos, há a possibilidade de que a memória possa ser substituída. Para obter mais informações sobre como definir tamanhos de estrutura, consulte o tópico alocação de memória .

Retornar valor

Retorna um identificador de solicitação positivo se a operação assíncrona for iniciada; caso contrário, um destes valores de erro negativos:

LINEERR_INVALADDRESSID, LINEERR_INVALLINEHANDLE, LINEERR_INVALPOINTER, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_UNINITIALIZED.

Comentários

Observação

O cabeçalho tapi.h define lineGetAgentStatus como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.