summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2016-07-19 23:23:28 +0000
committerGreg Ercolano <erco@seriss.com>2016-07-19 23:23:28 +0000
commit243652161092d6de67f1b211f50f983b776d5638 (patch)
tree25e4408c473c46dcb95e03a438793a57f9f5bcf8
parentec4120795d70e30b77668f85bc77a4a922729580 (diff)
Bringing over this fix from 1.3 current to the porting branch.
Document savefile() return value, see also references to/from outputfile() git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11823 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/Fl_Text_Buffer.H9
1 files changed, 9 insertions, 0 deletions
diff --git a/FL/Fl_Text_Buffer.H b/FL/Fl_Text_Buffer.H
index b466ceb00..a204d02db 100644
--- a/FL/Fl_Text_Buffer.H
+++ b/FL/Fl_Text_Buffer.H
@@ -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
+ 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); }