dt_setparm( )

Description | Cautions | Example | Errors | See Also

Name:	int dt_setparm(devh,param,valuep)
Inputs:	int devh	Digital Network Interface logical board device handle
	unsigned long param	device parameter defined name
	void* valuep	pointer to device parameter value
0Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h
Category:	Parameter Setting
Mode:	synchronous

Description

The dt_setparm( ) function changes the value of a DNI device parameter.

Parameter	Description
devh:	Specifies the valid Digital Network Interface logical board device handle returned by a call to dt_open( )
param:	Specifies the parameter value to alter
valuep:	Specifies the address of the integer containing the value to be assigned to the parameter

All time slots on the selected Digital Network Interface device must be closed when this function is called.

Table 6, found in the dt_getparm( ) function description, lists each parameter name, its default value, and a brief description.

Cautions

1. This function will fail under the following conditions:
   • An invalid Digital Network Interface logical board device handle is specified.
   • One or more time slots on the Digital Network Interface device are open.
   • The parameter specified is invalid.
   • The Digital Network Interface is in test mode (remote loopback switch set to ON) and DTG_SETBDMD is passed in the param field.
2. Changing a Digital Network Interface device parameter affects all the time slots on the logical board. All the time slots on a logical board must be closed when device parameters are altered.
3. All values of the parameter have to be integers, but since this routine expects a void pointer to valuep, the address must be cast as a void*.

Example

#include <windows.h>      /* For Windows applications only */  
#include <srllib.h>  
#include <dtilib.h>  
#include <errno.h>  
main()  
{  
   int devh;              /* Board device handle */  
   int valuep;            /* Parameter value */  
   /*  
    * Open board 1 device  
    */  
   if ( ( devh = dt_open( "dtiB1", 0 ) ) == -1 ) {  
      printf( "Cannot open board dtiB1.  errno = %d", errno );  
      exit( 1 );  
   }  
   /*  
    * Set current clock parameter value  
    */  
   valuep = DTC_EXT;  
   if ( dt_setparm( devh, DTG_SETCLK, ( void * )&valuep ) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
              .  
              .  
              .  
}

Errors

If the function returns -1, use the SRL Standard Attribute function ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive error message. See Appendix A - Standard Runtime Library for more information on SRL functions. The error codes returned by ATDV_LASTERR( ) are:

• EDT_BADBRDERR - Digital Network Interface missing or defective
• EDT_BADCMDERR - invalid or undefined command to driver
• EDT_BADGLOB - invalid param
• EDT_BADVAL - invalid parameter value passed in valuep pointer
• EDT_DATTO - data reception timed out
• EDT_FWERR - firmware returned an error
• EDT_INVBD - invalid Digital Network Interface logical board device handle
• EDT_NOCLK - no clock source present
• EDT_NOIDLEERR - time slot not in idle/closed state
• EDT_NOMEMERR - cannot map or allocate memory in driver
• EDT_PARAMERR - invalid parameter
• EDT_RANGEERR - bad/overlapping physical memory range
• EDT_SIZERR - message too big or too small
• EDT_SKIPRPLYERR - a required reply was skipped
• EDT_SYSTEM - system error. Check the global variable errno for more information about the error.
• EDT_TMOERR - timed out waiting for reply from firmware
• EDT_TSTMOD - in test mode; cannot set Digital Network Interface mode

Error defines can be found in the file dtilib.h.

See Also

• dt_getparm( )

Click here to contact Dialogic Customer Engineering