Intel 05-1832-002 IP Phone User Manual


 
Voice API for Windows Operating Systems Library Reference — November 2003 115
return user-defined tone ID that terminated I/O function — ATDX_TONEID( )
ATDX_TONEID( )
return user-defined tone ID that terminated I/O function
!
!!
! Description
The ATDX_TONEID( ) function returns the user-defined tone ID that terminated an I/O function.
This termination is indicated by ATDX_TERMMSK( ) returning TM_TONE.
!
!!
! Cautions
None.
!
!!
! Errors
This function will fail and return AT_FAILURE if an invalid channel device handle is specified in
chdev.
!
!!
! Example
#include <stdio.h>
#include <srllib.h>
#include <dxxxlib.h>
#include <windows.h>
#define TID_1 101
main()
{
TN_GEN tngen;
DV_TPT tpt[ 5 ];
int chdev;
Name: long ATDX_TONEID(chdev)
Inputs: int chdev
valid channel device handle
Returns: user-defined tone ID if successful
AT_FAILURE if error
Includes: srllib.h
dxxxlib.h
Category: Extended Attribute
Mode: synchronous
Platform: DM3, Springware
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was opened
using dx_open( )