cnfCreateConference

Creates a new conference.

Prototype

DWORD cnfCreateConference ( CNFRESOURCEHD cnfresourcehd, CNF_CONFERENCE_PARMS *parms, DWORD *confid)

Argument

Description

cnfresourcehd

Handle returned by cnfOpenResource.

parms

Pointer to a CNF_CONFERENCE_PARMS structure:

typedef struct
{
  DWORD size;                              /* Size of the structure */
  DWORD flags;           /* Flags to describe capabilities not used */
  DWORD allocated_members;          /* Number of members to allocate*/
  DWORD user_value;                     /*Application-provided value*/
} CNF_CONFERENCE_PARMS; 

Refer to CNF.CONFERENCE for complete field descriptions.

If parms is NULL, take the default parameters.

confid

Pointer for the new conference identifier.


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

confid is a NULL pointer.

CTAERR_BOARD_ERROR

Conference cannot be created because of an HMIC limitation or an on-board memory limitation (only with AG 2000 boards).

CTAERR_INVALID_HANDLE

cnfresourcehd is not a valid conference resource handle.

CNFERR_BOARD_TIMEOUT

Board timed out while waiting for a response message.

CNFERR_INVALID_PARAMETER

parms is inconsistent or out of range.

CNFERR_NOT_ENOUGH_RESOURCE_SPACE

Conference cannot be created because the resource is full. Either the number of reserved seats with the requested capabilities is exhausted, or the number of conference IDs for that resource is exhausted. There are only 255 conference IDs per conference resource.


Details

cnfCreateConference creates a new conference on the resource specified by cnfresourcehd. If the function succeeds, the new conference identifier is returned in confid.

Refer to Creating conferences for more information.

See also

cnfGetConferenceInfo, cnfGetResourceList, cnfResizeConference

Example

extern CNFRESOURCEHD cnfresourcehd;
 
DWORD myCreateConference(unsigned allocated)
{
   DWORD confid;
   DWORD error;
   CNF_CONFERENCE_PARMS confparms;

   confparms.size = sizeof(CNF_CONFERENCE_PARMS);
   confparms.allocatedmembers = allocated;
   confparms.flags = CNF_NO_ECHO_CANCEL | CNF_NO_TONE_CLAMPING;
   confparms.user_value = NULL;
   error = cnfCreateConference (cnfresourcehd, &confparms,
                                &confid); 
   if (error != SUCCESS)
      {
      printf("Error when creating conference : %d", error);
      return(error);
      }
   return(confid);   
}