From 20236a8a990cae729bca1f7a4e0d619e92a5e37d Mon Sep 17 00:00:00 2001 From: Damien George Date: Sat, 20 Dec 2014 21:15:16 +0000 Subject: stmhal: Upgrade to latest fatfs driver. --- stmhal/fatfs/doc/en/read.html | 74 ------------------------------------------- 1 file changed, 74 deletions(-) delete mode 100644 stmhal/fatfs/doc/en/read.html (limited to 'stmhal/fatfs/doc/en/read.html') diff --git a/stmhal/fatfs/doc/en/read.html b/stmhal/fatfs/doc/en/read.html deleted file mode 100644 index 5acf85a8b..000000000 --- a/stmhal/fatfs/doc/en/read.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - -FatFs - f_read - - - - -
-

f_read

-

The f_read function reads data from a file.

-
-FRESULT f_read (
-  FIL* fp,     /* [IN] File object */
-  void* buff,  /* [OUT] Buffer to store read data */
-  UINT btr,    /* [IN] Number of bytes to read */
-  UINT* br     /* [OUT] Number of bytes read */
-);
-
-
- -
-

Parameters

-
-
fp
-
Pointer to the open file object.
-
buff
-
Pointer to the buffer to store read data
-
btr
-
Number of bytes to read in range of UINT type.
-
br
-
Pointer to the UINT variable to return number of bytes read. The value is always valid after the function call regardless of the result.
-
-
- - -
-

Return Values

-

-FR_OK, -FR_DISK_ERR, -FR_INT_ERR, -FR_NOT_READY, -FR_INVALID_OBJECT, -FR_TIMEOUT -

-
- - -
-

Description

-

The file read/write pointer of the file object advances number of bytes read. After the function succeeded, *br should be checked to detect the end of file. In case of *br is less than btr, it means the read/write pointer reached end of the file during read operation.

-
- - -
-

QuickInfo

-

Always available.

-
- - -
-

See Also

-

f_open, fgets, f_write, f_close, FIL

-
- -

Return

- - -- cgit v1.2.3