Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Include Page
css.uC-OS-III API Reference Manual.css
css.uC-OS-III API Reference Manual.css
Include Page
css.webworks.css
css.webworks.css

Anchor
1077730
1077730
µC/OS-III API Reference

Anchor
1077731
1077731
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:

Anchor
998326
998326
A brief description of the service

Anchor
998327
998327
The function prototype

Anchor
998328
998328
The filename of the source code

Anchor
998329
998329
The #define constant required to enable code for the service

Anchor
998330
998330
A description of the arguments passed to the function

Anchor
998331
998331
A description of returned value(s)

Anchor
998332
998332
Specific notes and warnings regarding use of the service

Anchor
998333
998333
One or two examples of how to use the function

Anchor
998334
998334
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.

Anchor
998335
998335
The next few pages summarizes most of the services provided by µC/OS-III. The function calls in bold are commonly used.