Using the function reference

This section provides an alphabetical reference to the CPI library functions. A typical function definition includes the following:

Prototype

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

  • U8 (8-bit unsigned)

  • S8 (8-bit signed)

  • U16 (16-bit unsigned)

  • S16 (16-bit signed)

  • U32 (32-bit unsigned)

  • S32 (32-bit signed)

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

Return values

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