(Page 1 of 13 in this chapter) Version

Chapter 5

Alphabetical Management Function Reference

5.1 Introduction

: TCAPAlarmControl 83
: TCAPGenCfg 85
: TCAPGenStatus 87
: TCAPGetGenCfg 89
: TCAPGetSapCfg 90
: TCAPInitGenCfg 91
: TCAPInitMgmtAPI 94
: TCAPInitSapCfg 95
: TCAPSapCfg 99
: TCAPSapStats 101
: TCAPTermMgmtAPI 104
: TCAPTraceControl 105

5.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the TCAP management API functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Some of the fields in the function definition include: Prototype The prototype is shown followed by a listing of the function's arguments. NMS Communications data types include: · U8 · S16 · U16 · U32 · Bool · 8-bit unsigned · 16-bit signed · 16-bit unsigned · 32-bit unsigned · 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 TCAP_SUCCESS or an error. For asynchronous functions, a return value of TCAP_SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.
Unlike the TCAP transaction API, which sends and receives messages asynchronously, each management API call generates a request followed immediately by a response from the TX board. This API blocks the calling application waiting for this response (typically a few hundred milliseconds) and returns an indication as to whether or not an action was completed successfully. For this reason it is expected that the management API will typically be employed by one or more management applications, separate from the applications utilizing the transaction API. The management API is packaged as a separate library with its own interface header files.

Prototype	The prototype is shown followed by a listing of the function's arguments. NMS Communications data types include:
	· U8 · S16 · U16 · U32 · Bool	· 8-bit unsigned · 16-bit signed · 16-bit unsigned · 32-bit unsigned · 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 TCAP_SUCCESS or an error. For asynchronous functions, a return value of TCAP_SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.

(Page 1 of 13 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Chapter 5

Alphabetical Management Function Reference

5.1 Introduction

Prototype

Return Values