DiaSpringWrapper.GatherDigits Method (String, Int32, DiaSpringWrapperCommon.DigitType)

DiaSpringWrapperGatherDigits Method (String, Int32, DiaSpringWrapperCommonDigitType)

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

public virtual void GatherDigits(
	string ChannelName,
	int GatherDigitTimeout,
	DiaSpringWrapperCommonDigitType Digit
)

Public Overridable Sub GatherDigits ( 
	ChannelName As String,
	GatherDigitTimeout As Integer,
	Digit As DiaSpringWrapperCommonDigitType
)

public:
virtual void GatherDigits(
	String^ ChannelName, 
	int GatherDigitTimeout, 
	DiaSpringWrapperCommonDigitType Digit
)

abstract GatherDigits : 
        ChannelName : string * 
        GatherDigitTimeout : int * 
        Digit : DiaSpringWrapperCommonDigitType -> unit 
override GatherDigits : 
        ChannelName : string * 
        GatherDigitTimeout : int * 
        Digit : DiaSpringWrapperCommonDigitType -> unit

Parameters

ChannelName: Type: SystemString
The Channel name on the Dialogic board on which to gather the digit.
GatherDigitTimeout: Type: SystemInt32
The timeout period for gathering the digit. The timeout occurs when the condition digit is not met within the specified timeout value.
Digit: Type: InkostarDiaSpringWrapperCommonDigitType
The expected digit. The function will return as soon as the specified digit is received.

Remarks

Use this overloaded method when only one specific digit is expected.

Remarks

This function will fail if invoked before the [device].Open() function.

Examples

Gather digit 5 on the first channel. The timeout period allowed to gather the digit is 3 seconds.
C#: objDevice.GatherDigits("dxxxB1C1", 3, Inkostar.DiaSpringWrapperCommon.DigitType.Five);
VB.NET: objDevice.GatherDigits("dxxxB1C1", 3, Inkostar.DiaSpringWrapperCommon.DigitType.Five)

Reference

DiaSpringWrapper Class

GatherDigits Overload

Inkostar Namespace