Previous PageTable Of Contents../index.htmlIndexNext Page

dcb_evtstatus( )

Description | Cautions | Example | Errors | See Also

Name:

int dcb_evtstatus(event, action, status)

Inputs:

unsigned char event

  event ID

  unsigned char action   action to be performed
  unsigned char *status   pointer to status of event-generation

Returns:

0 on success

  -1 on failure

Includes:

srllib.h

  dcblib.h
  dtilib.h
  msilib.h

Category:

Auxiliary

Mode:

synchronous

Top Of PageDescription

The dcb_evtstatus( ) function gets or sets the status of a process-wide event. Certain features of the Dialogic Audio Conferencing software are board-level features in that they are enabled or disabled on a per board basis. Process-wide events are enabled or disabled once for all devices used by that process.

Parameter

Description

event:

The specified process-wide event.

action:

Specifies whether the event status is to be set or retrieved.

status:

If the event status is being set, ON or OFF is passed to the function in this parameter. If the event status is being retrieved, this parameter will contain ON or OFF when the function returns.

event must be set to MSG_RESTBL. MSG_RESTBL controls the resource table update event generation. The resource assignment table is the mapping of resources to conferees. Anytime there is a change in this mapping and event generation is enabled, a DCBEV_CTU event is generated. Associated with this event is the resource table. An application may be in the resource table implementing active talkers. When this event notification is enabled, and the application makes a change to the assignment of conferencing resources on a DCB/SC board, a DCBEV_CTU event will be generated. The updated resource table will be returned as the event data. Refer to the code example for details.

action may be set to SET_EVENT or GET_EVENT.

The status parameter may contain ON or OFF.

To enable an event handler for a specified event, follow these steps:

  1. Call sr_enbhdlr( ). This function specifies the event and the application defined event handler that is called from a signal handler.
  2. Call dcb_evtstatus( ). This function sets the digit message mask.
NOTE:
The request for an event to be posted to an event handler must be specified using both the sr_enbhdlr( ) and dcb_evtstatus( ) functions.

Top Of PageCautions

dcb_evtstatus( ) is a process-wide function and does not have a Dialogic device-handle as one of its parameters. Any event set ON or OFF is set for all devices used by the process, not for any particular device.

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