MÉTHODE ITLegacyCallMediaControl2 ::GatherDigits (tapi3if.h)

Article
03/04/2024

La méthode GatherDigits lance la collecte de chiffres sur l’appel spécifié. L’application spécifie le nombre maximal de chiffres à collecter.

Syntaxe

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

Paramètres

[in] DigitMode

Mode(s) numérique(s) à surveiller. Ce paramètre spécifie une ou plusieurs constantes LINEDIGITMODE .

[in] lNumDigits

Nombre de chiffres à collecter.

Si ce paramètre est égal à zéro, la méthode annule toute collecte de chiffres en cours, sans commencer une nouvelle tentative de collecte de chiffres. Pour plus d'informations, consultez la section Notes qui suit.

[in] pTerminationDigits

Pointeur vers une représentation BSTR des chiffres d’arrêt. Si l’un des chiffres d’arrêt dans la chaîne est détecté, ce chiffre est ajouté à la mémoire tampon, la collection de chiffres est terminée et l’événement TE_GATHERDIGITS est envoyé à l’application.

[in] lFirstDigitTimeout

Durée, en millisecondes, pendant laquelle le premier chiffre est attendu. Si le premier chiffre n’est pas reçu dans cette période, la collecte de chiffres est abandonnée et un événement TE_GATHERDIGITS est envoyé à l’application. La mémoire tampon contient uniquement le caractère NULL , indiquant qu’aucun chiffre n’a été reçu et que le délai d’expiration du premier chiffre a pris fin. Les délais d’expiration minimum et maximal que vous pouvez spécifier se trouvent dans les fonctionnalités AC_GATHERDIGITSMINTIMEOUT et AC_GATHERDIGITSMAXTIMEOUT.

[in] lInterDigitTimeout

Durée maximale, en millisecondes, entre les chiffres consécutifs. Si le chiffre suivant n’est pas reçu dans cette période, la collection de chiffres est abandonnée et un événement TE_GATHERDIGITS est envoyé à l’application. La mémoire tampon contient uniquement les chiffres collectés jusqu’à ce point suivis d’un caractère NULL , indiquant qu’un interdigit-timeout a arrêté la collecte de chiffres. Les délais d’expiration minimum et maximal qui peuvent être spécifiés se trouvent dans les fonctionnalités AC_GATHERDIGITSMINTIMEOUT et AC_GATHERDIGITSMAXTIMEOUT.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	La méthode a réussi.
E_POINTER	Le paramètre pTerminationDigits n’est pas un pointeur valide.
E_OUTOFMEMORY	Il n’y a pas suffisamment de mémoire pour allouer la mémoire tampon des chiffres de collecte.
TAPI_E_INVALCALLSTATE	L’appel doit être dans l’état connecté .

Remarques

La méthode GatherDigits se traduit par un appel au TAPI 2. fonction xlineGatherDigits .

Un seul appel GatherDigits peut être en attente sur un appel. Si vous appelez à nouveau GatherDigits , avant que l’événement TE_GATHERDIGITS se produise, le deuxième appel annule la collecte précédente de chiffres. Les tentatives de collecte de chiffres annulées envoient un événement TE_GATHERDIGITS avec les chiffres collectés jusqu’à présent.

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	tapi3if.h
Bibliothèque	Uuid.lib
DLL	Tapi3.dll

Voir aussi

ITLegacyCallMediaControl2

Partager via