Mercurial > octave-nkf
changeset 20474:97edbce9b975 stable
doc: Clarify that ARCH argument to fread overrides ARCH arg to fopen.
* file-io.cc (Ffread): Clarify that ARCH argument to fread overrides ARCH arg
to fopen.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 11 Aug 2015 09:55:59 -0700 |
| parents | 8fcbb55745ef |
| children | 4c4d8fe5583a |
| files | libinterp/corefcn/file-io.cc |
| diffstat | 1 files changed, 5 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/file-io.cc Sun Aug 09 20:24:42 2015 -0700 +++ b/libinterp/corefcn/file-io.cc Tue Aug 11 09:55:59 2015 -0700 @@ -1609,7 +1609,12 @@ IEEE little endian.\n\ @end table\n\ \n\ +If no @var{arch} is given the value used in the call to @code{fopen} which\n\ +created the file descriptor is used. Otherwise, the value specified with\n\ +@code{fread} overrides that of @code{fopen} and determines the data format.\n\ +\n\ The output argument @var{val} contains the data read from the file.\n\ +\n\ The optional return value @var{count} contains the number of elements read.\n\ @seealso{fwrite, fgets, fgetl, fscanf, fopen}\n\ @end deftypefn")