SAA_channelGetInfo

vcanim.gif (8357 bytes) SAA_channelGetInfo
[ Home ] [ Sales ] [ Products ] [ Services ] [ Support ] [ Downloads ]

SAA_channelGetInfo

Retrieves information about the active drivers in a channel run.

set chnInfo [SAA_AllocChannelInfo]

SAA_channelGetInfo  $chnInfo

chnInfo: Returns driver information in a SAA_ChannelInfo structure:

   typedef struct {
      SAA_Boolean chnRunning ;
      SAA_Boolean chnTakeSetup ;
      SAA_Boolean chnTakeActive ;
      SAA_ChannelTakeTypes chnTakeSaveMode ;
      char *chnTakeLocation; /* Do not free */
      int chnTakeId ;
      SAA_ChannelAllDriversInfo *driverInfo ; /* Do not free */
   } SAA_ChannelInfo ;

This structure provides information on the state of the current channels session.

Through the driverInfo pointer you can access more information for each driver and each DOF. Each driver is represented by a SAA_ChannelDriverInfo structure, and each DOF is represented by a SAA_ChannelDriverDofInfo structure.

Return Value

Return correct usage if incorrect parameters are passed
"SI_ERR_BAD_ARGUMENT" if chnInfo is null.

[ SAA Index ] [ Examples SAA calls index ]