(Page 1 of 7 in this chapter)

Chapter 3

Alphabetical Function Reference

3.1 Introduction

: dtmGetTrunkStatus 20
: dtmRefreshTrunkStatus 22
: dtmResetCounters 23
: dtmSendAlarm 24
: dtmStartTrunkMonitor 25
: dtmStopTrunkMonitor 28

3.1 Introduction

This chapter provides a summary and a comprehensive, alphabetically-ordered reference to the DTM service API functions.
The DTM service API contains the following functions:

Function

S / A*

Description

dtmGetTrunkStatus

S

Retrieves complete status and statistics for a digital trunk.

dtmRefreshTrunkStatus

A

Requests a status event from a board.

dtmResetCounters

A

Resets error accumulators.

dtmSendAlarm

S

Starts or stops sending of an alarm on a digital trunk.

dtmStartTrunkMonitor

A

Starts monitoring a specified trunk.

dtmStopTrunkMonitor

A

Stops monitoring a specified trunk.

*Synchronous or Asynchronous
A prototype of each function is shown with the function description and details of all arguments and return values. A typical function description includes: Prototype The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include: · WORD · DWORD · INT16 · INT32 · BYTE 16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. Return Values The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS indicates the function was initiated; subsequent events indicate the status of the operation. Events If events are listed, the function is asynchronous and is complete when the DONE event is returned. If there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the value field of the event. Refer to Appendix B for details about DTM events. Example Example functions which start with Demo are excerpts taken from demonstration function libraries shipped with the product. Example functions which start with my are excerpts taken from sample application programs shipped with the product. The notation /* ... */ indicates additional code which is not shown.

Function	S / A*	Description
dtmGetTrunkStatus	S	Retrieves complete status and statistics for a digital trunk.
dtmRefreshTrunkStatus	A	Requests a status event from a board.
dtmResetCounters	A	Resets error accumulators.
dtmSendAlarm	S	Starts or stops sending of an alarm on a digital trunk.
dtmStartTrunkMonitor	A	Starts monitoring a specified trunk.
dtmStopTrunkMonitor	A	Stops monitoring a specified trunk.

Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
	· `WORD` · `DWORD` · `INT16` · `INT32` · `BYTE`	16-bit unsigned 32-bit unsigned 16-bit signed 32-bit signed 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined.
Return Values	The return value for a function is either `SUCCESS` or an error code. For asynchronous functions, a return value of `SUCCESS` indicates the function was initiated; subsequent events indicate the status of the operation.
Events	If events are listed, the function is asynchronous and is complete when the `DONE` event is returned. If there are no events listed, the function is synchronous. Additional information such as reason codes and return values may be provided in the `value` field of the event. Refer to Appendix B for details about DTM events.
Example	Example functions which start with `Demo` are excerpts taken from demonstration function libraries shipped with the product. Example functions which start with `my` are excerpts taken from sample application programs shipped with the product. The notation `/* ... */` indicates additional code which is not shown.

(Page 1 of 7 in this chapter)

tech_support@nmss.com

Chapter 3

Alphabetical Function Reference

3.1 Introduction

Prototype

Return Values

Events

Example