ms_genziptone( )

---

Cautions | Errors | Example | See Also

Name:	int ms_genziptone (devh)
Inputs:	int devh	MSI station device handle
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h msilib.h
Category:	Station
Mode:	synchronous
Platform:	Springware

Description

The ms_genziptone( ) function generates a zip tone to the station associated with the device handle. A zip tone indicates an incoming call to agents using headsets.

The tone generated is defined by the zip tone block specified in the ms_setbrdparm( ) function description. Tone will only be generated to an MSI station that is not part of a conference or routed to a TDM bus time slot.

Parameter	Description
devh	the valid MSI station device handle returned by a call to ms_open( )

Cautions

This function fails when:

• The station device handle is invalid.
• Zip tone is disabled.
• On DM3 boards, this function fails with error: "Can't map or allocate memory in driver."

Errors

If this function returns -1 to indicate failure, obtain the reason for the error by calling the SRL standard attribute function ATDV_LASTERR( ) or ATDV_ERRMSGP( ) to retrieve either the error code or a pointer to the error description, respectively.

Refer to the error type tables found in Chapter 5, "Error Codes". Error defines can be found in dtilib.h or msilib.h.

Example

#include <windows.h>          /* For Windows applications only */
#include <errno.h>
#include "srllib.h"
#include "dtilib.h"
#include "msilib.h"  
int  chdev1;                  /*Station dev descriptor variable */  
/* Open  station 1 device */  
if ((chdev1 = ms_open("msiB1C1",0)) == -1) {
    printf( "Cannot open MSIB1C1: errno=%d", errno);
    exit(1);
}  
/* Generate Ziptone */
if (ms_genziptone(chdev1) == -1){
    printf("Error Message = %s",ATDV_ERRMSGP(chdev1));
    exit(1);
}  
/* Close station 1 */  
if ( ms_close(chdev1)) == -1) {
    printf( "Cannot Close MSIB1C1: errno=%d", errno);
    exit(1);
}  

See Also

• ms_setbrdparm( )

Click here to contact Telecom Support Resources