From a0086f707595daee7dbed37a44d8537dfc2c4483 Mon Sep 17 00:00:00 2001 From: Greg Ercolano Date: Sat, 25 Jun 2016 00:54:24 +0000 Subject: [PATCH] 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 --- FL/Fl_Text_Buffer.H | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/FL/Fl_Text_Buffer.H b/FL/Fl_Text_Buffer.H index 510fdb01e..4c6cf31a6 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 + 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); }