Função lineGetDevConfigA (tapi.h)

A função lineGetDevConfig retorna um objeto de estrutura de dados "opaco", com o conteúdo específico da linha (provedor de serviços) e da classe de dispositivo. O objeto de estrutura de dados armazena a configuração atual de um dispositivo de fluxo de mídia associado ao dispositivo de linha.

Sintaxe

LONG lineGetDevConfigA(
  DWORD       dwDeviceID,
  LPVARSTRING lpDeviceConfig,
  LPCSTR      lpszDeviceClass
);

Parâmetros

dwDeviceID

Identificador do dispositivo de linha a ser configurado.

lpDeviceConfig

Ponteiro para o local de memória do tipo VARSTRING em que a estrutura de configuração do dispositivo é retornada. Após a conclusão bem-sucedida da solicitação, esse local é preenchido com a configuração do dispositivo. O membro dwStringFormat na estrutura de VARSTRING está definido como STRINGFORMAT_BINARY. Antes de chamar lineGetDevConfig, 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 os dados possam ser substituídos. Para obter mais informações sobre como definir tamanhos de estrutura, consulte o tópico alocação de memória.

 

lpszDeviceClass

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica a classe de dispositivo do dispositivo cuja configuração é solicitada. A classe de dispositivo válida lineGetID cadeias de caracteres são as mesmas especificadas para a função.

Valor de retorno

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

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_STRUCTURETOOSMALL, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_UNINITIALIZED, LINEERR_NODEVICE.

Observações

Os estados de chamada são específicos do dispositivo.

A função lineGetDevConfig pode ser usada para recuperar uma estrutura de dados do TAPI que especifica a configuração de um dispositivo de fluxo de mídia associado a um dispositivo de linha específico. Por exemplo, o conteúdo dessa estrutura pode especificar taxa de dados, formato de caractere, esquemas de modulação e configurações de protocolo de controle de erro para um dispositivo de mídia "datamodem" associado à linha.

Normalmente, um aplicativo chama lineGetID para identificar o dispositivo de fluxo de mídia associado a uma linha e, em seguida, chama lineConfigDialog para permitir que o usuário configure a configuração do dispositivo. Em seguida, ele pode chamar lineGetDevConfige salvar as informações de configuração em uma lista telefônica (ou outro banco de dados) associada a um destino de chamada específico. Quando o usuário mais tarde quiser chamar o mesmo destino novamente, lineSetDevConfig poderá ser usado para restaurar as configurações selecionadas pelo usuário. As funções lineSetDevConfig, lineConfigDialoge lineGetDevConfig podem ser usadas, nessa ordem, para permitir que o usuário exiba e atualize as configurações.

O formato exato dos dados contidos na estrutura é específico para a API de fluxo de linha e mídia (classe de dispositivo), não está documentado e é indefinido. A estrutura retornada por essa função não pode ser acessada ou manipulada diretamente pelo aplicativo, mas só pode ser armazenada intacta e posteriormente usada em lineSetDevConfig para restaurar as configurações. A estrutura também não pode necessariamente ser passada para outros dispositivos, mesmo da mesma classe de dispositivo (embora isso possa funcionar em alguns casos, não é garantido).

Nota

O cabeçalho tapi.h define lineGetDevConfig 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

Referência dos Serviços básicos de telefonia

visão geral de referência do TAPI 2.2

VARSTRING

lineConfigDialog

lineGetID

lineSetDevConfig