Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 9 of 20 in this chapter) Version

cdiStartRing

Description

Starts ringing a station.

Prototype

DWORD cdiStartRing (CTAHD ctahd,
CDI_RING_PARMS *parms )
ctahd CTA context handle.
parms Pointer to structure specifying ring cadence:

typedef struct
{
DWORD size;
DWORD cadence_type;
} CDI_RING_PARMS

Return Values

SUCCESS
CTAERR_FUNCTION_ACTIVE
This function has already been invoked, and the DSP is ringing the station.
CTAERR_INVALID_CTAHD
The CTA handle is invalid.
CTAERR_INVALID_STATE
The port must be on-hook to invoke this function.
CTAERR_BOARD_ERROR
The board is overheating, and has reached the Protection state. At this stage, the board will not accept nor place any calls on any ports. Refer to Section 4.5 for details.
CTAERR_BAD_ARGUMENT
An argument is not in the valid range.

Events

None.

Details

This function causes a station to ring. The station must be on-hook.
The cadence_type parameter in the CDI_RING_PARMS structure determines the pattern (cadence) of the ring. CX 2000 products are pre-configured with three different six-second cadences to choose from: cadence_type Setting Cadence 0 "ring...ring..." 1 "ring ring...ring ring..." 2 "ring ring ring...ring ring ring..." Note: You can change one or more of these cadences, if you wish. For more information, see the CX 2000C Installation and Developer's Manual.
If the board is running in enhanced mode, the DSP automatically stops ringing when the station is taken off-hook. Otherwise, invoke cdiStopRing to stop ringing a station. (Refer to Section 3.2 for more information about enhanced mode.)
For more information about ringing, refer to Section 3.5.

See Also

cdiStopRing

Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 9 of 20 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.