Previous PageTable Of Contents../index.htmlIndexNext Page

dcb_getcnflist( )

Description | Cautions | Example | Errors | See Also

Name:

int dcb_getcnflist(devh,confid,numpty,cdt)

Inputs:

int devh

  DCB/SC DSP device handle

 

int confid

  conference identifier

 

int *numpty

  pointer to the conferee count

 

MS_CDT *cdt

  pointer to conference descriptor table

Returns:

0 on success
-1 on failure

Includes:

srllib.h
dtilib.h
msilib.h
dcblib.h

Category:

Conference

Mode:

synchronous

Top Of PageDescription

The dcb_getcnflist( ) function retrieves a conferee list and the total number of parties within a conference. The list contains specific information about each conferee in that conference. The information includes each conferee's SCbus transmit time slot number, selector, and conferee attribute description.

NOTE:
The list is not returned in any specified order.

Parameter

Description

devh:

The DCB/SC DSP device handle.

confid:

The conference identifier.

numpty:

Pointer to the conferee count.

cdt:

Pointer to the conference descriptor table.

NOTE:
The application is responsible for allocating an MS_CDT table with sufficient elements. Refer to the sample code.

When a conference is being monitored, one member of the conference list will be the monitor. chan_num for the monitor will equal 0x7FFF and chan_sel will be MSPN_TS.

The conference descriptor table is an array of the MS_CDT structure. The MS_CDT structure has the following format:

Top Of PageCautions

  1. This function fails when an invalid conference ID is specified.
  2. It is the responsibility of the application to allocate enough memory for the conference descriptor table. There must be an MS_CDT element allocated for each conferee description returned by this function. For example, if a conference was started with four conferees, and three conferees were added later, the MS_CDT array must be able to hold seven entries.
    NOTE:
    Even though dcb_monconf( ) does not use the CDT structure, the array must have an additional structure if the conference is being monitored.

Top Of PageExample

Top Of PageErrors

If the function does not complete successfully, it will return -1 to indicate an error. Use the Standard Attribute functions ATDV_LASTERR( ) to obtain the applicable error value, or ATDV_ERRMSGP( ) to obtain a more descriptive error message.

Refer to the error type tables found in Chapter 2 of this guide. Error defines can be found in dtilib.h, msilib.h or dcblib.h.

Top Of PageSee Also


Previous PageTable Of ContentsTop Of PageIndexNext Page

Click here to contact Dialogic Customer Engineering

Copyright 2000, Dialogic Corporation
All rights reserved
This page generated January, 2002