Função lineConfigDialog (tapi.h)

Artigo
03/02/2024

A função lineConfigDialog faz com que o provedor do dispositivo de linha especificado exiba uma caixa de diálogo (anexada a hwndOwner do aplicativo) para permitir que o usuário configure parâmetros relacionados ao dispositivo de linha.

Sintaxe

LONG lineConfigDialog(
  DWORD  dwDeviceID,
  HWND   hwndOwner,
  LPCSTR lpszDeviceClass
);

Parâmetros

dwDeviceID

Identificador do dispositivo de linha a ser configurado.

hwndOwner

Manipule para uma janela à qual a caixa de diálogo deve ser anexada. Pode ser NULL para indicar que qualquer janela criada durante a função não deve ter nenhuma janela de proprietário.

lpszDeviceClass

Ponteiro para uma cadeia de caracteres terminada em nulo que identifica um nome de classe de dispositivo. Essa classe de dispositivo permite que o aplicativo selecione uma sub-tela específica das informações de configuração aplicáveis a essa classe de dispositivo. Esse parâmetro é opcional e pode ser deixado NULL ou vazio, nesse caso, a configuração de nível mais alto é selecionada.

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:

LINEERR_BADDEVICEID, LINEERR_NOMEM, LINEERR_INUSE, LINEERR_OPERATIONFAILED, LINEERR_INVALDEVICECLASS, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALPARAM, LINEERR_UNINITIALIZED, LINEERR_INVALPOINTER, LINEERR_OPERATIONUNAVAIL, LINEERR_NODEVICE.

Comentários

A função lineConfigDialog faz com que o provedor de serviços exiba uma caixa de diálogo modal (anexada a hwndOwner do aplicativo) para permitir que o usuário configure parâmetros relacionados à linha especificada por dwDeviceID. O parâmetro lpszDeviceClass permite que o aplicativo selecione uma sub-tela específica das informações de configuração aplicáveis à classe de dispositivo na qual o usuário está interessado; as cadeias de caracteres permitidas são as mesmas que para lineGetID. Por exemplo, se a linha der suporte à API comm, passar "COMM" como lpszDeviceClass fará com que o provedor exiba os parâmetros relacionados especificamente ao Comm (ou, pelo menos, comece no ponto correspondente em uma cadeia de caixas de diálogo de configuração multinível, para que o usuário não precise "cavar" para localizar os parâmetros de interesse).

O parâmetro lpszDeviceClass seria "tapi/line", "" ou NULL para fazer com que o provedor exiba a configuração de nível mais alto da linha.