Método ITLegacyCallMediaControl2::GatherDigits (tapi3if.h)

O método GatherDigits inicia a coleta de dígitos na chamada especificada. O aplicativo especifica o número máximo de dígitos a serem coletados.

Sintaxe

HRESULT GatherDigits(
  [in] TAPI_DIGITMODE DigitMode,
  [in] long           lNumDigits,
  [in] BSTR           pTerminationDigits,
  [in] long           lFirstDigitTimeout,
  [in] long           lInterDigitTimeout
);

Parâmetros

[in] DigitMode

Os modos de dígito a serem monitorados. Esse parâmetro especifica uma ou mais das constantes LINEDIGITMODE .

[in] lNumDigits

O número de dígitos a serem coletados.

Se esse parâmetro for zero, o método cancelará qualquer coleta de dígitos em andamento, sem iniciar uma nova tentativa de coleta de dígitos. Para obter mais informações, consulte a seção Comentários a seguir.

[in] pTerminationDigits

Ponteiro para uma representação BSTR dos dígitos de terminação. Se um dos dígitos de terminação na cadeia de caracteres for detectado, esse dígito será acrescentado ao buffer, a coleção de dígitos será encerrada e o evento TE_GATHERDIGITS será enviado ao aplicativo.

[in] lFirstDigitTimeout

O período de tempo, em milissegundos, durante o qual o primeiro dígito é esperado. Se o primeiro dígito não for recebido nesse período, a coleção de dígitos será anulada e um evento TE_GATHERDIGITS será enviado ao aplicativo. O buffer contém apenas o caractere NULL , indicando que nenhum dígito foi recebido e que o primeiro dígito-tempo limite terminou a coleta de dígitos. Os tempos limite mínimo e máximo que você pode especificar são encontrados nos recursos AC_GATHERDIGITSMINTIMEOUT e AC_GATHERDIGITSMAXTIMEOUT.

[in] lInterDigitTimeout

O tempo máximo, em milissegundos, entre dígitos consecutivos. Se o próximo dígito não for recebido nesse período, a coleção de dígitos será anulada e um evento TE_GATHERDIGITS será enviado ao aplicativo. O buffer contém apenas os dígitos coletados até esse ponto seguidos por um caractere NULL , indicando que um interdigit-timeout encerrou a coleta de dígitos. Os tempos limite mínimo e máximo que podem ser especificados são encontrados nos recursos AC_GATHERDIGITSMINTIMEOUT e AC_GATHERDIGITSMAXTIMEOUT.

Retornar valor

Esse método pode retornar um desses valores.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
E_POINTER	O parâmetro pTerminationDigits não é um ponteiro válido.
E_OUTOFMEMORY	Não há memória suficiente para alocar o buffer de dígitos de coleta.
TAPI_E_INVALCALLSTATE	A chamada deve estar no estado conectado .

Comentários

O método GatherDigits é convertido em uma chamada para o TAPI 2. Xfunção lineGatherDigits .

Somente uma chamada GatherDigits pode ser pendente em uma chamada. Se você chamar GatherDigits novamente, antes que o evento TE_GATHERDIGITS tenha ocorrido, a segunda chamada cancelará a coleta anterior de dígitos. Tentativas de coleta de dígitos canceladas enviam um evento TE_GATHERDIGITS com os dígitos coletados até agora.

Requisitos

Requisito	Valor
Plataforma de Destino	Windows
Cabeçalho	tapi3if.h
Biblioteca	Uuid.lib
DLL	Tapi3.dll

Confira também

ITLegacyCallMediaControl2