Fixed return value documentation of SdFile::write()

giszo · giszo · commit df67a6a912aa · 2016-08-23T09:01:17.000+02:00
diff --git a/src/utility/SdFile.cpp b/src/utility/SdFile.cpp
@@ -1124,7 +1124,7 @@ uint8_t SdFile::truncate(uint32_t length) {
  * \param[in] nbyte Number of bytes to write.
  *
  * \return For success write() returns the number of bytes written, always
- * \a nbyte.  If an error occurs, write() returns -1.  Possible errors
+ * \a nbyte.  If an error occurs, write() returns 0.  Possible errors
  * include write() is called before a file has been opened, write is called
  * for a read-only file, device is full, a corrupt file system or an I/O error.
  *

Original file line number	Diff line number	Diff line change
`@@ -1124,7 +1124,7 @@ uint8_t SdFile::truncate(uint32_t length) {`
`1124`	`1124`	`* \param[in] nbyte Number of bytes to write.`
`1125`	`1125`	`*`
`1126`	`1126`	`* \return For success write() returns the number of bytes written, always`
`1127`		`- * \a nbyte. If an error occurs, write() returns -1. Possible errors`
	`1127`	`+ * \a nbyte. If an error occurs, write() returns 0. Possible errors`
`1128`	`1128`	`* include write() is called before a file has been opened, write is called`
`1129`	`1129`	`* for a read-only file, device is full, a corrupt file system or an I/O error.`
`1130`	`1130`	`*`