cnfGetConferenceInfo

Returns information about a conference such as the number of members allocated, the number of members attending, and the conference capabilities.

Prototype

DWORD cnfGetConferenceInfo ( CNFRESOURCEHD cnfresourcehd, DWORD confid, CNF_CONFERENCE_INFO *confinfo, unsigned size)

Argument

Description

cnfresourcehd

Handle returned by cnfOpenResource.

confid

Conference identifier returned by cnfCreateConference.

confinfo

Pointer to a CNF_CONFERENCE_INFO structure:

typedef struct
{
  DWORD size;                 /* size of the structure       */
  DWORD allocated_members;    /* number of members allocated */
                              /* for this conference         */
  DWORD joined_members;       /* number of members attending */
                              /* this conference             */
  DWORD flags;                /* capabilities not used flags */
  DWORD capabilities;
  DWORD user_value;
} CNF_CONFERENCE_INFO; 

Refer to the Details section for a description of these fields.

size

The size of the buffer pointed by confinfo.


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

confinfo pointer is NULL.

CTAERR_BAD_SIZE

size is smaller than the size of CNF_CONFERENCE_INFO.

CTAERR_INVALID_HANDLE

cnfresourcehd is not a valid conference resource handle.

CNFERR_INVALID_IDENTIFIER

confid is not a valid conference identifier.


Details

cnfGetConferenceInfo returns the information structure for the conference designated by confid.

The CNF_CONFERENCE_INFO structure contains the following fields:

Field

Description

size

Number of bytes written to the buffer pointed to by confinfo.

allocated_members

Number of members allocated on the conference resource for this conference.

joined_members

Number of members currently joined in this conference.

flags

Capabilities disabled at conference creation time.

capabilities

Capabilities enabled at conference creation time.

user_value

Application prompted value.


For more information, refer to Setting conference attributes.

See also

cnfCreateConference, cnfGetConferenceList, cnfGetMemberInfo, cnfGetResourceInfo

Example

extern CNFRESOURCEHD cnfresourcehd;
 
INT32 getNumberOfMember(DWORD confid)
{
   CNF_CONFERENCE_INFO confinfo;
   error = cnfGetConferenceInfo (cnfresourcehd, confid, &confinfo,
                                 sizeof(CNF_CONFERENCE_INFO)); 
   if (error != SUCCESS)
      {
      printf("Error when retrieving conference information :
                %d",error);
      }
   return(confinfo.joined_member);
}