Added a comment about return codes

git-svn-id: svn://svn.cc65.org/cc65/trunk@3438 b7a2c559-68d2-44c3-8de9-860c34a00d81

diff --git a/include/dio.h b/include/dio.h
index 694430657afff0cb2af0d91d963e5b434e8802ae..5303c949abb0c7dc28e3faf3d91d0242d3642418 100644 (file)
--- a/include/dio.h
+++ b/include/dio.h
@@ -35,6 +35,14 @@
 
 
 
+/* Please note: All functions in this file will set _oserror *and* return its
+ * value. The only exception is dio_open, which will return NULL, but _oserror
+ * will be set. All function will also set _oserror in case of successful
+ * execution, effectively clearing it.
+ */
+
+
+
 /*****************************************************************************/
 /*                                   Data                                   */
 /*****************************************************************************/