Intel 05-1832-002 IP Phone User Manual


 
Voice API for Windows Operating Systems Library Reference — November 2003 421
return the status of tone set file loading — dx_TSFStatus( )
dx_TSFStatus( )
return the status of tone set file loading
!
!!
! Description
The dx_TSFStatus( ) function returns the status of tone set file loading. Tone set file (TSF)
loading is an optional procedure used to customize the default call progress analysis tone
definitions with TSF tone definitions created by the PBX Expert utility. TSF loading occurs when
you execute your application and a valid, existing TSF was configured and enabled in the
configuration manager (DCM).
!
!!
! Cautions
None.
!
!!
! Errors
If this function returns a negative value (corresponding to the EDX_ define below), it indicates that
the TSF failed to load for one of the following error reasons:
EDX_SYSTEM
Error from operating system; use dx_fileerrno( ) to obtain error value. Failed to load
PBXPERT.DLL.
EDX_BADREGVALUE
Unable to locate value in registry. The configuration manager (DCM) does not specify a TSF
name and therefore the registry either doesn’t contain a value for “TSF Download File” or the
PBX Expert key is missing.
EDX_BADTSFFILE
The TSF specified in the configuration manager (DCM) does not exist or is not a valid TSF
file.
EDX_BADTSFDATA
TSF data not consolidated. The TSF specified in the configuration manager (DCM) does not
contain valid downloadable data.
Name: int dx_TSFStatus ( void )
Inputs: None
Returns: 0 if TSF loading was successful
non-zero value if TSF loading failed; see EDX error codes for reason
Includes: srllib.h
dxxxlib.h
Category: Configuration
Mode: synchronous
Platform: Springware