cdiStopRing

Stops station ringing.

Prototype

DWORD cdiStopRing ( CTAHD ctahd)

Argument

Description

ctahd

Context handle.


Return values

Return value

Description

SUCCESS

 

CTAERR_FUNCTION_NOT_ACTIVE

Ringing was already stopped, either by a previous invocation of this function or automatically by the DSP.

CTAERR_INVALID_CTAHD

Handle is invalid.


Details

If a board is not running in enhanced mode, use cdiStopRing to stop station ringing (started using cdiStartRing).

If the board is running in enhanced mode, the DSP automatically stops station ringing when the station is taken off-hook (CDIEVN_OFF_HOOK is returned). In this case, cdiStopRing returns CTAERR_FUNCTION_NOT_ACTIVE.

Refer to Ringing for more information.