µC/OS-III API Reference
This chapter provides a reference to µC/OS-III services. Each of the user-accessible kernel services is presented in alphabetical order. The following information is provided for each entry:
A brief description of the service
The function prototype
The filename of the source code
The #define constant required to enable code for the service
A description of the arguments passed to the function
A description of returned value(s)
Specific notes and warnings regarding use of the service
One or two examples of how to use the function
Most µC/OS-III API functions return an error code. In fact, when present, the error return value is done through the last argument of the API function, as a pointer to an error code. These error codes should be checked by the application to ensure that the µC/OS-III function performed its operation as expected. Also, some of the error codes are conditional based on configuration constants. For example, argument checking error codes are returned only if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h.
The next few pages summarizes most of the services provided by µC/OS-III. The function calls in bold are commonly used.