Reads the first digit in the ADI service internal digit queue without removing it.
AG
CG
DWORD adiPeekDigit ( CTAHD ctahd, char *digit)
|
Argument |
Description |
|
ctahd |
Context handle returned by ctaCreateContext or ctaAttachContext. |
|
digit |
Pointer to a character to store the digit copied from the digit queue. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
digit is a NULL pointer. |
|
CTAERR_FUNCTION_ACTIVE |
Digit collection function is already active. |
|
CTAERR_INVALID_CTAHD |
Context handle is invalid. |
|
CTAERR_INVALID_STATE |
Function not valid in the current port state. |
|
CTAERR_SVR_COMM |
Server communication error. |
adiPeekDigit reads a single DTMF digit character from the front of the ADI service internal digit queue without removing it. The digit is copied to the address pointed to by digit. Valid digit values are the ASCII characters 0 through 9, # (number sign), and * (asterisk), as well as A, B, C, and D. If the digit queue is empty, the value is 0 (zero).
This function cannot be invoked if the application is actively collecting digits using adiCollectDigits.
For more information, refer to Collecting digits.