Using the function reference

This section provides an alphabetical reference to the NaturalConference functions. A typical function description includes:

Prototype

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

  • WORD 16-bit unsigned

  • DWORD 32-bit unsigned

  • INT16 16-bit signed

  • INT32 32-bit signed

  • BYTE 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.

Example

Example functions that start with Demo are excerpts taken from demonstration function libraries shipped with the product.

Example functions that start with my are excerpts taken from sample application programs shipped with the product.

The notation /* ... */ indicates additional code that is not shown.