lm_clrparm( )

Description | Cautions | Errors | Example | See Also

Name:	void lm_clrparm(lm_parmp)
Inputs:	LM_PARM *lm_parmp	pointer to the LM_PARM
Outputs:	none
Returns:	none
Includes:	srllib.h dxxxlib.h lmodelib.h
Mode:	synchronous
Category:	learn mode
Platform:	Springware

Description

The lm_clrparm( ) function clears the learn mode parameters structure (LM_PARM). The function initializes all fields in the structure to their default value.

Call this function before setting values in the lm_LearnTone( ) function lm_parmp parameter.

Parameter	Description
lm_parmp	Points to the LM_PARM structure that is to be cleared.

Cautions

None.

Errors

For a list of error codes, see Section 5.2.  Learn Mode Error Codes.

Example

#include <fcntl.h>  
#include <errno.h>  
#include <stdio.h>  
#include "srllib.h"  
#include "dxxxlib.h"  
#include "lmodelib.h"  
#define DEVICE "dxxxB1C1"  
#define ERR  -1  
int lrn_Learn(int lrnDev);  
int main()  
{  
int i,rc;  
int Caller;  
/* learn the dial tone here */  
/* Prepare the scenario for dial tone */  
if ((Caller  = dx_open(DEVICE,(int)NULL)) == ERR)  
{  
//Error occurred in opening DEVICE  
//Handle the error here and return  
//error  
return(ERR);  
}  
if ( dx_sethook(Caller, DX_OFFHOOK, EV_SYNC) == ERR)  
{  
//Error to set off hook  
return(ERR);  
}  
printf("Start learning...............\n");  
if ((rc = lrn_Learn(Caller)) != ERR)  
{  
printf("Finish learning...............\n");  
}  
else  
{  
printf("Error in Learning...\n");  
}  
//reset the channel  
return 0;  
}  
int lrn_Learn(int Dev)  
{  
   LM_PARM parm;  
   TN_AMP amp;  
   TN_DESC desc;  
   short flagDual;  
int ret = -1;  
lm_clrparm(&parm);
  
lm_clramp(&amp);  
lm_clrdesc(&desc);  
flagDual = 0;  //Unknown  
//set necessary fields of lm_parm  
parm.lm_frames = 10;  
parm.lm_qualid = QT_LMMID;  
parm.lm_cadflag = 0;  
/* min duration for tone to qualify as continuous */  
parm.lm_cnt_min = 400;    
parm.lm_method = 2;  
ret = lm_LearnTone(Dev, &parm, &amp, &flagDual, NULL, &desc, NULL, EV_SYNC, NULL);  
if( ret == ERR )  
{  
//Learning failed so process and return error  
return(ERR):  
}  
/*process tone ( frequency and cadence) information returned in desc structure. */  
return(ret);  
}

See Also

• lm_LearnTone( )
• lm_clrdesc( )
• lm_clramp( )

Click here to contact Telecom Support Resources