µC/FS API Reference

This chapter provides a reference to µC/FS services. 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

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

Each of the user-accessible file system services is presented in alphabetical order within an appropriate section; the section for a particular function can be determined from its name.