ms_getcde( )

---

Cautions | Errors | Example | See Also

Name:	int ms_getcde (devh, confID, cdt)
Inputs:	int devh	MSI board device handle
	int confID	conference identifier
	MS_CDT *cdt	pointer to MS_CDT structure
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h msilib.h
Category:	Conference Management
Mode:	synchronous
Platform:	DI, HDSI, Springware

Description

The ms_getcde( ) function retrieves the attributes of a participant in an existing conference. This function requires that the participant's chan_num and chan_sel are specified in the MS_CDT structure. On successful completion of this function, the conference party attribute will be returned in the chan_attr field of the MS_CDT structure.

Parameter	Description
devh	the MSI board device handle
confID	the conference identifier
cdt	pointer to structure, see for MS_CDT for details.

The chan_attr field is a bitmask that describes the party's properties within the conference. Possible returns are listed in Table 2. It is possible that a combination of any of the attributes shown in the table will be returned.

Table 2. Possible Returns for Channel Attribute

Channel Attribute	Description
MSPA_NULL	No special attributes for party
MSPA_RO	Party participates in conference in receive-only mode
MSPA_TARIFF	Party receives periodic tone for duration of call
MSPA_COACH	Party is a coach - coach is heard by pupil only
MSPA_PUPIL	Party is a pupil - pupil hears everyone including coach
MSPA_NOAGC	Disabled automatic gain control

Note: Invoke ms_getcde( ) multiple times if the attributes of more than one party are desired.

Cautions

This function fails when:

• The device handle specified is invalid.
• An invalid conference ID is specified.
• The queried party is not in the conference.

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"  
#define      NUM_PARTIES    2
int  dev1=1;                 /* Board dev descriptor variables */
MS_CDT  cdt[NUM_PARTIES];    /* Conf. desc. table */
int  confID;                 /* Conf. ID */
int  attr;                   /* Channel attribute */
int  station, ts;  
/* Start the system */  
/* Set up CDT structure */
cdt[0].chan_num = station ;  /* station is a valid station number */
cdt[0].chan_sel = MSPN_STATION;
cdt[0].chan_attr = MSPA_NULL;  
/* SCbus time slot to be conferenced */
cdt[1].chan_num = ts ;        /* ts should be a valid time slot */
cdt[1].chan_sel = MSPN_TS;
cdt[1].chan_attr = MSPA_NULL;  
/* Establish conference */
if (ms_estconf(dev1, cdt, NUM_PARTIES, MSCA_ND, &confID) == -1) {
    printf("Error Message = %s",ATDV_ERRMSGP(dev1));
    exit(1);
}  
/*
 *
 * Continue processing
 *
 */  
/* Now get the attribute of MSI Station */
cdt[0].chan_num = station;      /* Station in the conference */
cdt[0].chan_sel = MSPN_STATION;  
if( ms_getcde(dev1, confID, &cdt[0])== -1){
    printf("Error Message = %s",ATDV_ERRMSGP(dev1));
    exit(1);
}  
attr = cdt[0].chan_attr;  
/*
 * Continue Processing
 *
 */  

See Also

• ms_setcde( )

Click here to contact Telecom Support Resources