ag_getxmitslot( )

Description | Cautions | Example | Errors | See Also

Name:	int ag_getxmitslot(chdev, sc_tsinfop)
Inputs:	int chdev	analog channel handle
	SC_TSINFO *sc_tsinfop	pointer to SCbus time slot information structure
Returns:	0 on success
	-1 on error
Includes:	dxxxlib.h
Category:	SCbus Routing
Mode:	Synchronous

Description

The ag_getxmitslot( ) function provides SCbus time slot number of the analog transmit channel. The SCbus time slot information is contained in an SC_TSINFO structure that also includes the number of the SCbus time slot connected to the analog transmit channel.

NOTE:

SCbus convenience function nr_scroute( ) includes ag_getxmitslot( ) functionality. See the SCbus Routing Guide for more information on convenience functions.

Parameter	Description
chdev:	Specifies the valid analog channel handle obtained when the channel was opened using dx_open( ).
sc_tsinfop:	Specifies a pointer to the data structure SC_TSINFO.

The SC_TSINFO structure is declared as follows:

     typedef struct {  
          unsigned long sc_numts;  
          long  *sc_tsarrayp;  
     } SC_TSINFO;

The sc_numts member of the SC_TSINFO structure must be initialized with the number of SCbus time slots requested which will be 1 for an analog channel. The sc_tsarrayp member of the SC_TSINFO structure must be initialized with a pointer to a valid array of longs. Upon return from the function, the first element of the array will contain the number (between 0 and 1023) of the SCbus time slot on which the analog channel transmits.

An analog channel can transmit on only one SCbus time slot.

Cautions

This function will fail when:

• An invalid channel handle is specified.
• A PEB time slot is requested.

Example

#include <windows.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <errno.h>
  
main( )  
{  
   int chdev;                 /* Channel device handle */  
   SC_TSINFO sc_tsinfo;       /* Time slot information structure */  
   long scts;                 /* SCbus time slot */  
   /* Open board 1 channel 1 devices */  
   if ((chdev = dx_open("dxxxB1C1", 0)) == -1) {  
      printf("Cannot open channel dxxxB1C1.  errno = %d", errno);  
      exit(1);  
   }  
   /* Fill in the SCbus time slot information */  
   sc_tsinfo.sc_numts = 1;  
   sc_tsinfo.sc_tsarrayp = &scts;  
   /* Get SCbus time slot connected to transmit of analog channel 1 on board ...1 */  
   if (ag_getxmitslot(chdev, &sc_tsinfo) == -1) {  
      printf("Error message = %s", ATDV_ERRMSGP(chdev));  
      exit(1);  
   }  
   printf("%s is transmitting on SCbus time slot %d", ATDV_NAMEP(chdev), ...scts);  
}

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. One of the following error codes may be returned:

Equate	Returned When
EDX_BADPARM	Parameter error
EDX_SH_BADCMD	Command is not supported in current bus configuration
EDX_SH_BADINDX	Invalid Switch Handler library index number
EDX_SH_BADLCTS	Invalid channel number
EDX_SH_BADMODE	Function not supported in current bus configuration
EDX_SH_BADTYPE	Invalid channel type (voice, analog, etc.)number
EDX_SH_CMDBLOCK	Blocking command is in progress
EDX_SH_LCLDSCNCT	Channel is already disconnected from SCbus time slot
EDX_SH_LIBBSY	Switch Handler library busy
EDX_SH_LIBNOTINIT	Switch Handler library uninitialized
EDX_SH_MISSING	Switch Handler is not present
EDX_SH_NOCLK	Switch Handler clock fallback failed
EDX_SYSTEM	Windows system error

See Also

• dt_listen( )
• dx_listen( )
• fx_listen( )
• ms_listen( )

Click here to contact Dialogic Customer Engineering