Waits for DTMF input and returns the digit(s) keyed by the user in a form of an event within the EventReceived handler.

Namespace:  Inkostar
Assembly:  DiaSpringWrapper (in DiaSpringWrapper.dll)
Version: 0.0.0.0

Syntax

         
 C#  Visual Basic  Visual C++ 
public virtual void GatherDigits(
	string ChannelName,
	int GatherDigitTimeout,
	DiaSpringWrapperCommon..::.DigitType TerminatingDigit,
	int MaximumDigits
)
Public Overridable Sub GatherDigits ( _
	ChannelName As String, _
	GatherDigitTimeout As Integer, _
	TerminatingDigit As DiaSpringWrapperCommon..::.DigitType, _
	MaximumDigits As Integer _
)
public:
virtual void GatherDigits(
	String^ ChannelName, 
	int GatherDigitTimeout, 
	DiaSpringWrapperCommon..::.DigitType TerminatingDigit, 
	int MaximumDigits
)

Parameters

ChannelName
String
The Channel name on the Dialogic board on which to gather the digits.
GatherDigitTimeout
Int32
The timeout period for gathering all digits. The timeout occurs when neither conditions TerminatingDigit and MaximumDigits are met within the specified timeout value.
TerminatingDigit
DiaSpringWrapperCommon..::.DigitType
The digit expected to end the DTMF input. The function will return as soon as this condition is met.
MaximumDigits
Int32
The maximum number of input digits. The function will return as soon as this condition is met.

Remarks

Use this overloaded method when more than one digit is expected.

Remarks

This function will fail if invoked before the [device].Open() function.
Specify Inkostar::DiaSpringWrapperCommon::DigitType::None when you need the user to enter a specific number of digits which is specified in parameter MaximumDigits and no termination is required (for example when expecting a credit card number.)

Examples

Gather up to 10 digits including the terminating digit # on the first channel. The timeout period to complete gathering all digits is 7 seconds.
C#: objDevice.GatherDigits("dxxxB1C1", 7, Inkostar.DiaSpringWrapperCommon.DigitType.Pound, 10);
VB.NET: objDevice.GatherDigits("dxxxB1C1", 7, Inkostar.DiaSpringWrapperCommon.DigitType.Pound, 10)

See Also

DiaSpringWrapper Class
Inkostar Namespace