Função lineTranslateAddress (tapi.h)

Artigo
08/26/2023

A função lineTranslateAddress converte o endereço especificado em outro formato.

Sintaxe

LONG lineTranslateAddress(
  HLINEAPP              hLineApp,
  DWORD                 dwDeviceID,
  DWORD                 dwAPIVersion,
  LPCSTR                lpszAddressIn,
  DWORD                 dwCard,
  DWORD                 dwTranslateOptions,
  LPLINETRANSLATEOUTPUT lpTranslateOutput
);

Parâmetros

hLineApp

Identificador retornado por lineInitializeEx. Se um aplicativo TAPI 2.x ainda não tiver chamado a função lineInitializeEx , ele poderá definir esse parâmetro como NULL. Os aplicativos TAPI 1.4 ainda devem chamar lineInitialize primeiro.

dwDeviceID

Identificador de dispositivo do dispositivo de linha no qual a chamada deve ser discada, para que as variações nos procedimentos de discagem em diferentes linhas possam ser aplicadas ao processo de tradução.

dwAPIVersion

Versão mais alta do TAPI compatível com o aplicativo (não necessariamente o valor negociado por lineNegotiateAPIVersion em algum dispositivo de linha específico).

lpszAddressIn

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o endereço das informações que devem ser extraídas para tradução. Deve estar no formato de endereço canônico ou em uma cadeia de caracteres arbitrária de dígitos discáveis (não canônicos). Esse parâmetro não deve ser NULL. Se o AddressIn contiver um subaddress ou um campo de nome ou endereços adicionais separados do primeiro endereço por caracteres CR e LF, somente o primeiro endereço será traduzido.

dwCard

O cartão de crédito a ser usado para discagem. Esse parâmetro só será válido se o bit CARDOVERRIDE estiver definido em dwTranslateOptions. Esse parâmetro especifica o identificador permanente de uma entrada de Cartão na seção [Cartões] no registro (conforme obtido de lineTranslateCaps) que deve ser usado em vez do PreferredCardID especificado na definição de CurrentLocation. Isso não faz com que o parâmetro PreferredCardID da entrada local atual no registro seja modificado; a substituição se aplica somente à operação de tradução atual. Esse parâmetro será ignorado se o bit CARDOVERRIDE não estiver definido em dwTranslateOptions.

dwTranslateOptions

Operações associadas a serem executadas antes da tradução do endereço em uma cadeia de caracteres discável. Esse parâmetro usa uma das constantes LINETRANSLATEOPTION_.

Se você definiu o bit LINETRANSLATEOPTION_CANCELCALLWAITING, também é aconselhável definir o bit LINECALLPARAMFLAGS_SECURE no membro dwCallParamFlags da estrutura LINECALLPARAMS (passado para lineMakeCall por meio do parâmetro lpCallParams ). Isso impede que o dispositivo de linha use dígitos discáveis para suprimir interrupções de chamada.

lpTranslateOutput

Ponteiro para uma área de memória alocada pelo aplicativo para conter a saída da operação de tradução, do tipo LINETRANSLATEOUTPUT. Antes de chamar lineTranslateAddress, o aplicativo deve definir o membro dwTotalSize dessa estrutura para indicar a quantidade de memória disponível para TAPI para retornar informações.

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_INVALPOINTER, LINEERR_INCOMPATIBLEAPIVERSION, LINEERR_NODRIVER, LINEERR_INIFILECORRUPT, LINEERR_NOMEM, LINEERR_INVALADDRESS, LINEERR_OPERATIONFAILED, LINEERR_INVALAPPHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALCARD, LINEERR_STRUCTURETOOSMALL, LINEERR_INVALPARAM.