dx_TSFStatus( )

Description | Cautions | Example | Errors | See Also

Name:	int dx_TSFStatus ( void )
Inputs:	None
Returns:	0	TSF loading was successful
	non-zero value	TSF loading failed; see EDX error codes for reason
Includes:	dxxxlib.h
Category:	Configuration
Mode:	synchronous

Description

The dx_TSFStatus( ) function returns the status of TSF loading. Tone Set File (TSF) loading is an optional procedure used to customize the default PerfectCall Call Progress Analysis tone definitions with TSF tone definitions created by PBXpert. TSF loading occurs when you execute your application and a valid, existing TSF was configured and enabled through the TSF Configuration application Advanced Options window.

The following procedure describes how to use a PBXpert Tone Set File:

1. Install a valid downloadable Tone Set File that was created and consolidated by PBXpert.
2. Use the TSF Configuration application Advanced Options window to enable TSF usage and to specify the path and file name.
   • An option is also provided to enable the disconnect tone.
   • You are allowed to specify a path or file name that does not exist, but a message will alert you to this fact.
3. Execute your application. If the specified TSF is valid, enabled, and can be located, the TSF data is loaded.
   • TSF loading only changes the default PerfectCall tone definitions; the application must still initialize PerfectCall with the dx_initcallp( ) function.
   • If TSF loading failed for any reason, it does not cause an error, and the default PerfectCall tone definitions are used as normal. The loading status is saved in a global flag that the application can check by calling the dx_TSFStatus( ) function to determine the outcome of the loading.

Cautions

None.

Example

/*$ dx_TSFStatus( ) example $*/



#include <stdio.h>

#include <dxxxlib.h>



main ( )

{

   int rc;



   rc = dx_TSFStatus ( );

   switch ( rc )

   {

   

      case 0:

         break;



      case EDX_SYSTEM:

         printf ( "General system error loading PBXpert.DLL \n");

         break;



      case EDX_BADREGVALUE:

         printf ( "Cannot find PBXpert registry entry\n");

         break;



      case EDX_BADTSFFILE:

         printf ( "Downloadable filename in registry invalid or does not exist \n");

         break;

   

      case EDX_BADTSFDATA:

         printf ("Downloadable TSF file does not contain valid consolidated data\n");

         break;





      case EDX_FEATUREDISABLED:

         printf ("TSF feature is disabled in Configuration Manager Advanced Options\n");

         break;



      default:

         break;

   }

}

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 the PBXPERT.DLL.
EDX_BADREGVALUE	Unable to locate value in registry. The TSF Configuration application Advanced Options window does not specify a TSF name and therefore the registry either doesn't contain a value for "TSF Download File" or the PBXpert key is missing.
EDX_BADTSFFILE	The TSF specified by the TSF Configuration application Advanced Options window does not exist or is not a valid TSF file.
EDX_BADTSFDATA	TSF data not consolidated. The TSF specified by the TSF Configuration application Advanced Options window does not contain valid downloadable data.
EDX_FEATUREDISABLED	The TSF feature is disabled in the TSF Configuration application Advanced Options window.

See Also

• dx_initcallp( )

Click here to contact Dialogic Customer Engineering