Метод ITLegacyCallMediaControl2::GatherDigits (tapi3if.h)
Метод GatherDigits инициирует сбор цифр в указанном вызове. Приложение указывает максимальное количество собираемых цифр.
Синтаксис
HRESULT GatherDigits(
[in] TAPI_DIGITMODE DigitMode,
[in] long lNumDigits,
[in] BSTR pTerminationDigits,
[in] long lFirstDigitTimeout,
[in] long lInterDigitTimeout
);
Параметры
[in] DigitMode
Отслеживаемые цифровые режимы. Этот параметр задает одну или несколько констант LINEDIGITMODE .
[in] lNumDigits
Количество собираемых цифр.
Если этот параметр равен нулю, метод отменяет любой выполняющийся сбор цифр, не запуская новую попытку сбора цифр. Дополнительные сведения см. в разделе "Примечания".
[in] pTerminationDigits
Указатель на представление символов завершения ВСТР . При обнаружении одной из цифр завершения в строке эта цифра добавляется в буфер, сбор цифр завершается и в приложение отправляется событие TE_GATHERDIGITS .
[in] lFirstDigitTimeout
Продолжительность времени (в миллисекундах), в течение которого ожидается первая цифра. Если первая цифра не получена в этот период времени, сбор цифр прерывается и в приложение отправляется событие TE_GATHERDIGITS . Буфер содержит только символ NULL , указывающий, что цифры не были получены и что время ожидания первой цифры завершило сбор цифр. Минимальное и максимальное время ожидания, которые можно указать, можно найти в возможностях AC_GATHERDIGITSMINTIMEOUT и AC_GATHERDIGITSMAXTIMEOUT.
[in] lInterDigitTimeout
Максимальное время (в миллисекундах) между последовательными цифрами. Если следующая цифра не получена в этот период времени, сбор цифр прерывается и в приложение отправляется событие TE_GATHERDIGITS . Буфер содержит только цифры, собранные до этого момента, за которым следует символ NULL , указывающий, что interdigit-timeout завершил сбор цифр. Минимальное и максимальное время ожидания, которое можно указать, можно найти в возможностях AC_GATHERDIGITSMINTIMEOUT и AC_GATHERDIGITSMAXTIMEOUT.
Возвращаемое значение
Этот метод может возвращать одно из этих значений.
Код возврата | Описание |
---|---|
|
Метод успешно выполнен. |
|
Параметр pTerminationDigits не является допустимым указателем. |
|
Недостаточно памяти для выделения буфера сбора цифр. |
|
Вызов должен находиться в подключенном состоянии. |
Комментарии
Метод GatherDigits преобразуется в вызов TAPI 2. Функция xlineGatherDigits .
В вызове может быть невыполненным только один вызов GatherDigits . При повторном вызове Метода GatherDigits до того, как произошло событие TE_GATHERDIGITS , второй вызов отменит предыдущий сбор цифр. Отмененные попытки сбора цифр отправляют событие TE_GATHERDIGITS с цифрами, собранными до сих пор.
Требования
Требование | Значение |
---|---|
Целевая платформа | Windows |
Header | tapi3if.h |
Библиотека | Uuid.lib |
DLL | Tapi3.dll |