Intel 05-1832-002 User Manual

Page of 564
200
Voice API for Windows Operating Systems Library Reference — November 2003
dx_enbtone( ) — enable detection of a user-defined tone
dx_enbtone( )
enable detection of a user-defined tone
!
!
!
Description
The dx_enbtone( ) function enables detection of a user-defined tone on a channel, including the 
tone-on and tone-off events for that tone. Detection capability for tones is enabled on a channel by 
default when 
 is called.
See the 
 function description for information about retrieving call status transition 
(CST) tone-on and tone-off events.
Use dx_enbtone( ) to enable a tone that was previously disabled using 
Name:
int  dx_enbtone(chdev, toneid, evt_mask)
Inputs:
int chdev
valid channel device handle
int toneid
tone template identification
int evt_mask
event mask
Returns:
0 if success
-1 if failure
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 
toneid 
specifies the user-defined tone identifier for which detection is being enabled 
To enable detection of all user-defined tones on the channel, set toneid to 
TONEALL.
evt_mask 
specifies whether to enable detection of the user-defined tone going on or 
going off. Set to one or both of the following using a bitwise-OR ( | ) operator.
DM_TONEON – disable TONE ON detection
DM_TONEOFF – disable TONE OFF detection
evt_mask affects the enabled/disabled status of the tone template and will 
remain in effect until dx_enbtone( ) or 
 is called again to reset it.