From: lottaviano Date: Mon, 14 Sep 2009 15:00:17 +0000 (+0000) Subject: doc: Add further documentation for fatfile_open(). X-Git-Tag: 2.2.0~33 X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=2196b004802798738cc32b2b3dd2d8eff7a7ba25;p=bertos.git doc: Add further documentation for fatfile_open(). git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2935 38d2e660-2303-0410-9eaa-f027e97ec537 --- diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h index 0dd1529f..3e7dc787 100644 --- a/bertos/fs/fat.h +++ b/bertos/fs/fat.h @@ -68,9 +68,15 @@ INLINE FatFile * FATFILE_CAST(KFile *fd) /** * Initialize \a file and open \a file_path for reading. + * + * \a mode is a OR combination of various flags, you can use \a FA_READ for + * read access or \a FA_WRITE for write access. + * The function returns \a FR_OK if success, other values (defined in ff.h) in case + * of failure. + * * \param file A pointer to a FatFile structure. * \param file_path The file path on the filesystem. - * \param mode Open mode for the file. + * \param mode Open mode for the file, which can be OR'ed together * \sa ff.h for return code meaning and \a mode flags. */ FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);