ms_remfromconf( )

---

Cautions | Errors | Example | See Also

Name:	int ms_remfromconf (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, Springware

Description

The ms_remfromconf( ) function removes a party from a conference. The conference ID is the value previously returned by the ms_estconf( ) function. In this case, the channel attributes of the MS_CDT structure are ignored.

Parameter	Description
devh	the MSI board device handle
confID	the conference identifier number
cdt	pointer to the conference descriptor table. See the MS_CDT data structure page for details.

Notes:

1. We recommend that you call ms_unlisten( ) before removing the TDM bus time slot member.
2. Calling this function frees one resource.

Cautions

• An error will be returned if this function is used to remove the last remaining party from a conference. The ms_delconf( ) function must be used to end a conference.
• This function fails when:
  • The device handle passed is invalid
  • The conference ID is invalid
  • The party to be removed is not part of the specified 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    3  
int  dev1;                  /* Board dev descriptor variables */
MS_CDT cdt[NUM_PARTIES];    /* Conf. desc. table */
int  confID;                /* Conf. ID */  
/* Open board 1 device */
if ((dev1 = ms_open("msiB1",0)) == -1) {
    printf( "Cannot open MSI B1: errno=%d", errno);
    exit(1);
}  
/*
 *  Continue processing
 */  
/* Set up CDT structure */
/* Assume  MSI stations 2, 4 and 7 are in the conference */
cdt[0].chan_num = 2;
cdt[0].chan_sel = MSPN_STATION;
cdt[0].chan_attr = MSPA_NULL;  
cdt[1].chan_num = 4
cdt[1].chan_sel = MSPN_STATION;
cdt[1].chan_attr = MSPA_PUPIL;  
cdt[2].chan_num = 7;
cdt[2].chan_sel = MSPN_STATION;
cdt[2].chan_attr = MSPA_COACH;  
/* Establish conference */
if (ms_estconf(dev1, cdt, NUM_PARTIES, MSCA_ND, &confID) != 0) {
    printf("Error Message = %s",ATDV_ERRMSGP(dev1));
    exit(1);
}  
/*
 * Continue processing
 *
 */  
cdt[0].chan_num = 2;
cdt[0].chan_sel = MSPN_STATION;  
if (ms_remfromconf(dev1, confID, &cdt[0]) == -1){
    printf("Error Message = %s",ATDV_ERRMSGP(dev1));
    exit(1);
}  
if (ms_delconf(dev1, confID) == -1){
    printf("Error Message = %s",ATDV_ERRMSGP(dev1));
    exit(1);  
} 
/* Continue processing */  

See Also

• ms_addtoconf( )
• ms_delconf( )
• ms_estconf( )

Click here to contact Telecom Support Resources