Using the function reference

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

Prototype

The prototype is followed by a list of the function's arguments. NMS 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. For more information, refer to the Data types overview.

Return values

and

Events

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.

For more information about errors, refer to NMS V5 library errors.

For more information about events, refer to NMS V5 library channel callback events.

Example

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

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