Intel 05-1832-002 User Manual

Page of 564
186
Voice API for Windows Operating Systems Library Reference — November 2003
dx_deltones( ) — delete all user-defined tones
dx_deltones( )
delete all user-defined tones
!
!
!
Description
The dx_deltones( ) function deletes all user-defined tones previously added to a channel with 
. If no user-defined tones were previously enabled for this channel, this function has 
no effect.
Note:
Calling this function deletes ALL user-defined tones set by 
, o
!
!
!
Cautions
When using this function in a multi-threaded application, use critical sections or a semaphore 
around the function call to ensure a thread-safe application. Failure to do so will result in “Bad 
Tone Template ID” errors.
!
!
!
Errors
If the function returns -1, use the Standard Runtime Library (SRL) Standard Attribute function 
ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive 
error message. One of the following error codes may be returned: 
EDX_BADPARM
Invalid parameter
EDX_BADPROD
Function not supported on this board
EDX_SYSTEM
Error from operating system; use dx_fileerrno( ) to obtain error value
Name:
int  dx_deltones(chdev)
Inputs:
int chdev
valid channel device handle
Returns:
0 if successful
-1 if error
Includes:
srllib.h
dxxxlib.h
Category:
Global Tone Detection
Mode:
synchronous 
Platform:
DM3, Springware 
Parameter
Description
chdev 
specifies the valid channel device handle obtained when the channel was opened 
using dx_open( )