Using the TCAP management function reference

This section provides an alphabetical reference to the TCAP management functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function includes:

Prototype

The prototype is followed by a listing of the function arguments. NMS data types include:

  • U8 (8-bit unsigned)

  • S16 (16-bit signed)

  • U16 (16-bit unsigned)

  • U32 (32-bit unsigned)

  • Bool (8-bit unsigned)

If a function argument is a data structure, the complete data structure is shown.

Return values

The return value for a function is either TCAP_SUCCESS or an error code. 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 service functions that send and receive messages asynchronously, each TCAP management function generates a request followed immediately by a response from the TX board. TCAP management functions block the calling application waiting for this response (typically a few hundred milliseconds) and return an indication as to whether or not an action was completed successfully. For this reason, the TCAP management functions are typically used by one or more management applications, separate from the applications that use the TCAP service functions. TCAP management is packaged as a separate library with its own interface header files.