Estrutura LINECALLPARAMS (tapi.h)

Artigo
03/08/2023

A estrutura LINECALLPARAMS descreve os parâmetros fornecidos ao fazer chamadas usando as funções lineMakeCall e TSPI_lineMakeCall . A estrutura LINECALLPARAMS também é usada como um parâmetro em outras operações, como a função lineOpen .

Os comentários à direita do bloco de sintaxe indicam os valores padrão usados quando essa estrutura não é fornecida a lineMakeCall.

Sintaxe

typedef struct linecallparams_tag {
  DWORD          dwTotalSize;
  DWORD          dwBearerMode;
  DWORD          dwMinRate;
  DWORD          dwMaxRate;
  DWORD          dwMediaMode;
  DWORD          dwCallParamFlags;
  DWORD          dwAddressMode;
  DWORD          dwAddressID;
  LINEDIALPARAMS DialParams;
  DWORD          dwOrigAddressSize;
  DWORD          dwOrigAddressOffset;
  DWORD          dwDisplayableAddressSize;
  DWORD          dwDisplayableAddressOffset;
  DWORD          dwCalledPartySize;
  DWORD          dwCalledPartyOffset;
  DWORD          dwCommentSize;
  DWORD          dwCommentOffset;
  DWORD          dwUserUserInfoSize;
  DWORD          dwUserUserInfoOffset;
  DWORD          dwHighLevelCompSize;
  DWORD          dwHighLevelCompOffset;
  DWORD          dwLowLevelCompSize;
  DWORD          dwLowLevelCompOffset;
  DWORD          dwDevSpecificSize;
  DWORD          dwDevSpecificOffset;
  DWORD          dwPredictiveAutoTransferStates;
  DWORD          dwTargetAddressSize;
  DWORD          dwTargetAddressOffset;
  DWORD          dwSendingFlowspecSize;
  DWORD          dwSendingFlowspecOffset;
  DWORD          dwReceivingFlowspecSize;
  DWORD          dwReceivingFlowspecOffset;
  DWORD          dwDeviceClassSize;
  DWORD          dwDeviceClassOffset;
  DWORD          dwDeviceConfigSize;
  DWORD          dwDeviceConfigOffset;
  DWORD          dwCallDataSize;
  DWORD          dwCallDataOffset;
  DWORD          dwNoAnswerTimeout;
  DWORD          dwCallingPartyIDSize;
  DWORD          dwCallingPartyIDOffset;
  DWORD          dwAddressType;
} LINECALLPARAMS, *LPLINECALLPARAMS;

Membros

dwTotalSize

Tamanho total alocado para essa estrutura de dados, em bytes. Esse tamanho deve ser grande o suficiente para conter todas as partes fixas e variavelmente dimensionadas dessa estrutura de dados.

dwBearerMode

Modo de portador para a chamada. Esse membro usa uma das constantes LINEBEARERMODE_.

Se dwBearerMode for zero, o valor padrão será LINEBEARERMODE_VOICE.

dwMinRate

Taxa mínima de dados solicitada para o fluxo de dados da chamada, em bps (bits por segundo).

dwMaxRate

Taxa máxima de dados solicitada para o fluxo de dados da chamada, em bps (bits por segundo). Ao fazer uma chamada, o provedor de serviços tenta fornecer a taxa mais alta disponível no intervalo solicitado (dwMinRate para dwMaxRate). Se uma taxa de dados específica for necessária, dwMinRate e dwMaxRate deverão ser definidos com esse valor. Se um aplicativo funciona melhor com uma taxa, mas é capaz de diminuir para taxas mais baixas, o aplicativo deve especificá-las como as taxas máximas e mínimas, respectivamente. Se dwMaxRate for zero, o valor padrão será conforme especificado pelo membro dwMaxRate da estrutura LINEDEVCAPS . Essa é a taxa máxima compatível com o dispositivo.

dwMediaMode

Tipo de mídia esperado da chamada. Esse membro usa uma das constantes LINEMEDIAMODE_.

Se dwMediaMode for zero, o valor padrão será LINEMEDIAMODE_INTERACTIVEVOICE.

dwCallParamFlags

Coleção de parâmetros boolianos de configuração de chamada. Esse membro usa uma ou mais das constantes LINECALLPARAMFLAGS_.

dwAddressMode

Modo pelo qual o endereço de origem é especificado. Esse membro usa uma das constantes LINEADDRESSMODE_.

Nota O membro dwAddressMode não pode ser LINEADDRESSMODE_ADDRESSID para a chamada de função lineOpen . No entanto, essa restrição não se aplica a lineMakeCall.

dwAddressID

Identificador de endereço do endereço de origem se dwAddressMode estiver definido como LINEADDRESSMODE_ADDRESSID. Um identificador de endereço está permanentemente associado a um endereço; o identificador permanece constante entre as atualizações do sistema operacional.

DialParams

Parâmetros de discagem a serem usados nessa chamada, do tipo LINEDIALPARAMS. Quando um valor de 0 é especificado para esse campo, o valor padrão do campo é usado conforme indicado no membro DefaultDialParams da estrutura LINEDEVCAPS . Se um valor diferente de zero for especificado para um campo que está fora do intervalo especificado pelos campos correspondentes em MinDialParams e MaxDialParams na estrutura LINEDEVCAPS , o valor mais próximo dentro do intervalo válido será usado.

dwOrigAddressSize

Tamanho do campo de endereço de origem, em bytes.

dwOrigAddressOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém o endereço de origem. O formato desse endereço depende do membro dwAddressMode . O tamanho do campo é especificado por dwOrigAddressSize.

dwDisplayableAddressSize

Tamanho da cadeia de caracteres que pode ser exibida, incluindo o terminador nulo , em bytes.

dwDisplayableAddressOffset

Cadeia de caracteres exibivel usada para fins de registro em log. O conteúdo desses membros é registrado nos membros dwDisplayableAddressOffset e dwDisplayableAddressSize da mensagem LINECALLINFO da chamada. A função lineTranslateAddress retorna informações apropriadas a serem colocadas nesse campo nos membros dwDisplayableAddressSize e dwDisplayableAddressOffset da estrutura LINETRANSLATEOUTPUT . O tamanho do campo é especificado por dwDisplayableAddressSize.

dwCalledPartySize

Tamanho das informações de terceiros, em bytes.

dwCalledPartyOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém informações de terceiros. Essas informações podem ser especificadas pelo aplicativo que faz a chamada e são disponibilizadas na estrutura de informações da chamada para fins de registro em log. O formato desse campo é o de dwStringFormat, conforme especificado em LINEDEVCAPS. O tamanho do campo é especificado por dwCalledPartySize.

dwCommentSize

Tamanho do campo de comentário de chamada, em bytes.

dwCommentOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém comentários sobre a chamada. Essas informações podem ser especificadas pelo aplicativo que faz a chamada e são disponibilizadas na estrutura de informações da chamada para fins de registro em log. O formato desse campo é o de dwStringFormat, conforme especificado em LINEDEVCAPS. O tamanho do campo é especificado por dwCommentSize.

dwUserUserInfoSize

Tamanho das informações do usuário-usuário, incluindo o terminador nulo , em bytes.

dwUserUserInfoOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém informações de usuário-usuário. O campo discriminador de protocolo para as informações do usuário-usuário, se necessário, deve aparecer como o primeiro byte dos dados apontados por dwUserUserInfoOffset e deve ser contabilizado em dwUserUserInfoSize.

dwHighLevelCompSize

Tamanho das informações de compatibilidade de alto nível, em bytes.

dwHighLevelCompOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém informações de compatibilidade de alto nível. O tamanho do campo é especificado por dwHighLevelCompSize.

dwLowLevelCompSize

Tamanho das informações de compatibilidade de baixo nível, em bytes.

dwLowLevelCompOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém informações de compatibilidade de baixo nível. O tamanho do campo é especificado por dwLowLevelCompSize.

dwDevSpecificSize

Tamanho das informações específicas do dispositivo, em bytes.

dwDevSpecificOffset

Deslocamento do início da estrutura para o campo de tamanho variável que contém informações específicas do dispositivo. O tamanho do campo é especificado por dwDevSpecificSize.

dwPredictiveAutoTransferStates

LINECALLSTATE_ constantes, entrada na qual faz com que a chamada seja transferida às cegas para o endereço de destino especificado. Defina como zero se a transferência automática não for desejada.

dwTargetAddressSize

Tamanho da cadeia de caracteres de endereço discável de destino, incluindo o terminador nulo , em bytes.

dwTargetAddressOffset

Deslocamento do início da estrutura para uma cadeia de caracteres especificando o endereço discável de destino (não dwAddressID); usado no caso de determinadas ações automáticas. No caso de discagem preditiva, especifica o endereço para o qual a chamada deve ser transferida automaticamente. O tamanho da cadeia de caracteres é especificado por dwTargetAddressSize.

Essa é essencialmente a mesma cadeia de caracteres que seria passada para lineBlindTransfer se a transferência automática não estivesse sendo usada. Defina como zero se a transferência automática não for desejada. No caso de uma Conferência sem Retenção, especifica o endereço que deve ser colocado em conferência para a chamada. No caso de uma Transferência de Uma Etapa, especifica o endereço a ser discado na chamada de consulta.

dwSendingFlowspecSize

Tamanho da qualidade das informações de serviço, em bytes.

dwSendingFlowspecOffset

Deslocamento do início da estrutura para uma estrutura FLOWSPEC seguida por dados específicos do provedor WinSock, equivalente ao que teria sido armazenado em SendingFlowspec em uma estrutura QOS . Especifica a qualidade do serviço desejado na direção de envio na chamada. A parte específica do provedor após a estrutura FLOWSPEC não deve conter ponteiros para outros blocos de memória, pois o TAPI não sabe como realizar marshaling dos dados apontados pelos ponteiros privados e transmiti-los por meio da comunicação entre processos com o aplicativo. O tamanho do campo é especificado por dwSendingFlowspecSize.

dwReceivingFlowspecSize

Tamanho da qualidade das informações de serviço, em bytes.

dwReceivingFlowspecOffset

Deslocamento do início da estrutura para uma estrutura FLOWSPEC seguida por dados específicos do provedor WinSock, equivalente ao que teria sido armazenado em ReceivingFlowspec em uma estrutura QOS . Especifica a qualidade do serviço desejado na direção de recebimento na chamada. A parte específica do provedor após a estrutura FLOWSPEC não deve conter ponteiros para outros blocos de memória, pois o TAPI não sabe como realizar marshaling dos dados apontados pelos ponteiros privados e transmiti-los por meio da comunicação entre processos com o aplicativo. O tamanho do campo é especificado por dwReceivingFlowspecSize.

dwDeviceClassSize

Tamanho da cadeia de caracteres da classe de dispositivo, incluindo o terminador nulo , em bytes.

dwDeviceClassOffset

Deslocamento do início da estrutura para uma cadeia de caracteres terminada em nulo que indica a classe de dispositivo do dispositivo cuja configuração é especificada em DeviceConfig. As cadeias de caracteres de classe de dispositivo válidas são as mesmas especificadas para a função lineGetID . O tamanho da cadeia de caracteres é especificado por dwDeviceClassSize.

dwDeviceConfigSize

Tamanho dos dados de configuração do dispositivo, em bytes.

dwDeviceConfigOffset

Deslocamento do início da estrutura para a estrutura de dados de configuração opaca. Esse valor é retornado no membro dwStringSize na estrutura VARSTRING retornada por lineGetDevConfig. Se o tamanho for zero, a configuração de dispositivo padrão será usada. Isso permite que o aplicativo defina a configuração do dispositivo antes que a chamada seja iniciada. O tamanho do campo é especificado por dwDeviceConfigSize.

dwCallDataSize

Tamanho dos dados de chamada configuráveis pelo aplicativo, em bytes.

dwCallDataOffset

Deslocamento do início da estrutura para os dados de chamada configuráveis pelo aplicativo a serem inicialmente anexados à chamada. O tamanho do campo é especificado por dwCallDataSize.

dwNoAnswerTimeout

Número de segundos, após a conclusão da discagem, que a chamada deve ter permissão para aguardar nos estados PROCEEDING ou RINGBACK, antes de ser abandonada automaticamente pelo provedor de serviços com um LINECALLSTATE_DISCONNECTED e LINEDISCONNECTMODE_NOANSWER. Um valor 0 indica que o aplicativo não deseja o abandono automático de chamadas.

dwCallingPartyIDSize

Tamanho da cadeia de caracteres de ID da parte de chamada, incluindo o terminador nulo , em bytes, incluindo o caractere de terminação nula.

dwCallingPartyIDOffset

Deslocamento do início da estrutura para uma cadeia de caracteres terminada em nulo que especifica a identidade da parte que está fazendo a chamada. Se o conteúdo do identificador for aceitável e um caminho estiver disponível, o provedor de serviços passará o identificador para a parte chamada para indicar a identidade da parte de chamada. O tamanho do campo é especificado por dwCallingPartyIDSize.

dwAddressType

Tipo de endereço usado para a chamada. Esse membro da estrutura só estará disponível se a versão TAPI negociada for 3.0 ou superior.

Comentários

As extensões específicas do dispositivo devem usar a área de tamanho variável DevSpecific (dwDevSpecificSize e dwDevSpecificOffset) dessa estrutura de dados.

Essa estrutura é usada como um parâmetro para lineMakeCall ao configurar uma chamada. Seus campos permitem que o aplicativo especifique a qualidade do serviço solicitado da rede, bem como uma variedade de parâmetros de configuração de chamada ISDN. Se nenhuma estrutura LINECALLPARAMS for fornecida para lineMakeCall, uma chamada padrão de nível de voz POTS será solicitada com os valores padrão listados acima.

Nota Os campos DialParams por meio de dwDevSpecificOffset são ignorados quando um parâmetro lpCallParams é especificado com a função lineOpen .

Os membros dwPredictiveAutoTransferStates por meio de dwCallingPartyIDOffset estão disponíveis apenas para aplicativos que abrem o dispositivo de linha com uma versão de API 2.0 ou posterior.