API

This section provides a reference to µC/Common user-accessible services. The following information is provided for each entry:

  • A brief description of the service
  • The filename of the source code
  • The function prototype
  • 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

Many functions return error codes. These error codes should be checked by the application to ensure that the µC/Common function performed its operation as expected.

Each of the user-accessible µC/Common services is presented within its appropriate section; the section for a particular function can be determined from its name.