Document savefile() return value, see also references to/from outputfile()

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@11799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Greg Ercolano 2016-06-25 00:54:24 +00:00
parent e964f33514
commit a0086f7075

View File

@ -322,11 +322,20 @@ public:
- non-zero on error (strerror() contains reason)
- 1 indicates open for write failed (no data saved)
- 2 indicates error occurred while writing data (data was partially saved)
\see savefile(const char *file, int buflen)
*/
int outputfile(const char *file, int start, int end, int buflen = 128*1024);
/**
Saves a text file from the current buffer
Saves a text file from the current buffer.
Returns
- 0 on success
- non-zero on error (strerror() contains reason)
- 1 indicates open for write failed (no data saved)
- 2 indicates error occurred while writing data (data was partially saved)
\see outputfile(const char *file, int start, int end, int buflen)
*/
int savefile(const char *file, int buflen = 128*1024)
{ return outputfile(file, 0, length(), buflen); }