| DiaGlobWrapperGetDigits Method (Channel, Int32, DiaGlobWrapperCommonDigitType, Int32, Boolean) |
diaGlobWrapper Help
Starts collecting a number of digits.
Namespace: InkostarAssembly: DiaGlobWrapper (in DiaGlobWrapper.dll) Version: 0.0.0.0
Syntaxpublic void GetDigits(
Channel CurrentChannel,
int GatherDigitTimeout,
DiaGlobWrapperCommonDigitType TerminatingDigit,
int MaximumDigits,
bool ClearDigitsBuffer
)
Public Sub GetDigits (
CurrentChannel As Channel,
GatherDigitTimeout As Integer,
TerminatingDigit As DiaGlobWrapperCommonDigitType,
MaximumDigits As Integer,
ClearDigitsBuffer As Boolean
)
public:
void GetDigits(
Channel^ CurrentChannel,
int GatherDigitTimeout,
DiaGlobWrapperCommonDigitType TerminatingDigit,
int MaximumDigits,
bool ClearDigitsBuffer
)
member GetDigits :
CurrentChannel : Channel *
GatherDigitTimeout : int *
TerminatingDigit : DiaGlobWrapperCommonDigitType *
MaximumDigits : int *
ClearDigitsBuffer : bool -> unit
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. - MaximumDigits
- Type: SystemInt32
The maximum number of digits expected including the terminating digit. An event of EventReceived.DigitsReceived will be generated when the maximum number of digits was collected. - 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 up to 5 digits with a terminating digit of # and a timeout of 5 seconds. Allowing the digits buffer to be cleared:
C#: objDevice.GetDigits(ChannelInbound, 5, Inkostar.DiaGlobWrapperCommon.DigitType.Pound, 5, true);
VB.NET: objDevice.GetDigits(ChannelInbound, 5, Inkostar.DiaGlobWrapperCommon.DigitType.Pound, 5, True)
See Also