Comment changes.
[crypto.git] / lib / silcutil / silcfileutil.h
index 151f45a4f0572c8951c4111b4674ad92affcbacb..b3b0312c31b14cac69ea23e78f411bf9657dfc7c 100644 (file)
@@ -58,7 +58,7 @@ int silc_file_open(const char *filename, int flags);
  *    Opens a file indicated by the filename `filename' with flags indicated
  *    by `flags'.  The argument `mode' specifies the permissions to use in
  *    case a new file is created.  The `flags' are defined in open(2).
- *    Returns the opened file descriptor or -1 on error.
+ *    Returns the opened file descriptor or -1 on error and sets silc_errno.
  *
  ***/
 int silc_file_open_mode(const char *filename, int flags, int mode);
@@ -72,7 +72,7 @@ int silc_file_open_mode(const char *filename, int flags, int mode);
  * DESCRIPTION
  *
  *    Reads data from file descriptor `fd' to `buf'.  Returns the amount of
- *    bytes read, 0 on EOF or -1 on error.
+ *    bytes read, 0 on EOF or -1 on error and sets silc_errno.
  *
  ***/
 int silc_file_read(int fd, unsigned char *buf, SilcUInt32 buf_len);
@@ -86,7 +86,7 @@ int silc_file_read(int fd, unsigned char *buf, SilcUInt32 buf_len);
  * DESCRIPTION
  *
  *    Writes `buffer' of length of `len' to file descriptor `fd'.  Returns
- *    the amount of bytes written, 0 on EOF or -1 on error.
+ *    the amount of bytes written, 0 on EOF or -1 on error and sets silc_errno.
  *
  ***/
 int silc_file_write(int fd, const char *buffer, SilcUInt32 len);
@@ -100,7 +100,7 @@ int silc_file_write(int fd, const char *buffer, SilcUInt32 len);
  * DESCRIPTION
  *
  *    Closes file descriptor previously opened with silc_file_open().
- *    Returns 0 on success or -1 on error.
+ *    Returns 0 on success or -1 on error and sets silc_errno.
  *
  ***/
 int silc_file_close(int fd);