Função lineGetAgentStatusA (tapi.h)

Artigo
11/20/2024

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

Sintaxe

LONG lineGetAgentStatusA(
  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 status do agente deve ser consultado. Um identificador de endereço está permanentemente associado a um endereço; o identificador permanece constante em atualizações do sistema operacional.

lpAgentStatus

Ponteiro para uma estrutura de tamanho variavelmente 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 dwTotalSize membro dessa estrutura para indicar a quantidade de memória disponível para TAPI para retornar informações.

Observação 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.

Valor de retorno

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.

Observações

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
da Plataforma de Destino	Windows
cabeçalho	tapi.h
biblioteca	Tapi32.lib
de DLL	Tapi32.dll

Consulte também

LINEAGENTSTATUS

Funções de serviço de linha suplementar

visão geral de referência do TAPI 2.2

Compartilhar via