This documentation is no longer maintained. For documentation of the current version of emc2, please see http://www.linuxcnc.org/docview/html

intro

NAME
DESCRIPTION
RTAPI STATUS CODES

NAME

rtapi − Introduction to the RTAPI API

DESCRIPTION

RTAPI is a library providing a uniform API for several real time operating systems. As of ver 2.1, RTLinux, RTAI, and a pure userspace simulator are supported.

The file rtapi.h defines the RTAPI for both realtime and non-realtime code. This is a change from Rev 2, where the non-realtime (user space) API was defined in ulapi.h and used different function names. The symbols RTAPI and ULAPI are used to determine which mode is being compiled, RTAPI for realtime and ULAPI for non-realtime.

RTAPI STATUS CODES

RTAPI_SUCCESS

call successfull

RTAPI_UNSUP

function not supported

RTAPI_BADID

bad task, shmem, sem, or fifo ID

RTAPI_INVAL

invalid argument

RTAPI_NOMEM

not enough memory

RTAPI_LIMIT

resource limit reached

RTAPI_PERM

permission denied

RTAPI_BUSY

resource is busy or locked

RTAPI_NOTFND

object not found

RTAPI_FAIL

operation failed