Using the function reference

This section provides an alphabetical reference to the Health Management service functions. A prototype of each function is shown with the function description and details of all arguments and return values.

Prototype

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

  • DWORD (8-bit unsigned)

  • S16 (16-bit signed)

  • U32 (32-bit unsigned)

  • Bool (8-bit unsigned)

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

Note: Not all parameters are applicable to both ANSI and ITU-T (CCITT) networks.

Return values

The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.