Click or drag to resize
DiaGlobWrapperGetDigits Method (Channel, Int32, DiaGlobWrapperCommonDigitType, Boolean)
diaGlobWrapper Help
Starts collecting one specific digit.

Namespace: Inkostar
Assembly: DiaGlobWrapper (in DiaGlobWrapper.dll) Version: 0.0.0.0
Syntax
Copy
public void GetDigits(
	Channel CurrentChannel,
	int GatherDigitTimeout,
	DiaGlobWrapperCommonDigitType TerminatingDigit,
	bool ClearDigitsBuffer
)

Parameters

CurrentChannel
Type: InkostarChannel
The Channel on the Dialogic board on which the function is to be executed.
GatherDigitTimeout
Type: SystemInt32
The timeout for either receiving the maximum number of digits or the terminating digits in seconds. An event of EventReceived.DigitsError will be generated when a timeout occurs.
TerminatingDigit
Type: InkostarDiaGlobWrapperCommonDigitType
The terminating digit. The function will generate an EventReceived.DigitsReceived event with the content of the digits buffer as soon as the terminating digit is received and even before the MaximumDigits was reached.
ClearDigitsBuffer
Type: SystemBoolean
Set to True to clear the content of the digits buffer before the function is executed. Set to False to keep the content of the buffer.
Remarks
This function can only be invoked when the channel has been opened.
Compatibility: All
On failure this function will generate an exception of type DiaGlobWrapperLibException
Examples
To start collecting the digit 1 with a timeout of 5 seconds and allowing the digits buffer to be cleared:
C#: objDevice.GetDigits(ChannelInbound, 5, Inkostar.DiaGlobWrapperCommon.DigitType.One, true);
VB.NET: objDevice.GetDigits(ChannelInbound, 5, Inkostar.DiaGlobWrapperCommon.DigitType.One, True)
See Also