Table of Contents Index NMS Glossary Previous Page Next Page (Page 23 of 23 in this chapter) Version


cnfStopTone

Description

Stops the tone generation started by cnfStartTone.

Prototype

DWORD cnfStopTone ( CNFRESOURCEHD reshd,
DWORD confid )

reshd Resource handle returned by cnfOpenResource.

confid Conference identifier returned by cnfCreateConference.

Return Values

Events

Details

This function terminates the tone generation started by cnfStartTone. If no tone was being played, the function returns SUCCESS.

For more information, refer to Section 4.9, Playing a Tone.

See Also

cnfStartTone

Example

extern CNFRESOURCEHD cnfresourcehd;

int stopConferenceTone( DWORD confid )
{
 CTA_EVENT event;

    if( cnfStopTone( cnfresourcehd,  confid) != SUCCESS )
        return MYFAILURE;

    do
    {
        myGetEvent( &event );        /* based on ctaWaitEvent   */

 } while( event.id != CNFEVN_TONE_DONE ); 

 if( CTA_IS_ERROR( event.value ) )
        return MYFAILURE;            /* API error                */
    else
        return SUCCESS;              /* started successfully     */

}



Table of Contents Index NMS Glossary Previous Page Next Page (Page 23 of 23 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.