File: Line_002dOriented-Input.html

package info (click to toggle)
octave 7.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 130,464 kB
  • sloc: cpp: 332,823; ansic: 71,320; fortran: 20,963; objc: 8,562; sh: 8,115; yacc: 4,882; lex: 4,438; perl: 1,554; java: 1,366; awk: 1,257; makefile: 652; xml: 173
file content (140 lines) | stat: -rw-r--r-- 7,479 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Line-Oriented Input (GNU Octave (version 7.3.0))</title>

<meta name="description" content="Line-Oriented Input (GNU Octave (version 7.3.0))">
<meta name="keywords" content="Line-Oriented Input (GNU Octave (version 7.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="C_002dStyle-I_002fO-Functions.html" rel="up" title="C-Style I/O Functions">
<link href="Formatted-Output.html" rel="next" title="Formatted Output">
<link href="Simple-Output.html" rel="prev" title="Simple Output">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="subsection" id="Line_002dOriented-Input">
<div class="header">
<p>
Next: <a href="Formatted-Output.html" accesskey="n" rel="next">Formatted Output</a>, Previous: <a href="Simple-Output.html" accesskey="p" rel="prev">Simple Output</a>, Up: <a href="C_002dStyle-I_002fO-Functions.html" accesskey="u" rel="up">C-Style I/O Functions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Line_002dOriented-Input-1"></span><h4 class="subsection">14.2.3 Line-Oriented Input</h4>

<p>To read from a file it must be opened for reading using <code>fopen</code>.
Then a line can be read from the file using <code>fgetl</code> as the following
code illustrates
</p>
<div class="example">
<pre class="example">fid = fopen (&quot;free.txt&quot;);
txt = fgetl (fid)
     -| Free Software is needed for Free Science
fclose (fid);
</pre></div>

<p>This of course assumes that the file &lsquo;<samp>free.txt</samp>&rsquo; exists and contains
the line &lsquo;<samp>Free Software is needed for Free Science</samp>&rsquo;.
</p>
<span id="XREFfgetl"></span><dl class="def">
<dt id="index-fgetl"><span class="category">: </span><span><em><var>str</var> =</em> <strong>fgetl</strong> <em>(<var>fid</var>)</em><a href='#index-fgetl' class='copiable-anchor'> &para;</a></span></dt>
<dt id="index-fgetl-1"><span class="category">: </span><span><em><var>str</var> =</em> <strong>fgetl</strong> <em>(<var>fid</var>, <var>len</var>)</em><a href='#index-fgetl-1' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Read characters from a file, stopping after a newline, or EOF,
or <var>len</var> characters have been read.
</p>
<p>The characters read, excluding the possible trailing newline, are returned
as a string.
</p>
<p>If <var>len</var> is omitted, <code>fgetl</code> reads until the next newline
character.
</p>
<p>If there are no more characters to read, <code>fgetl</code> returns -1.
</p>
<p>To read a line and return the terminating newline,
see <a href="#XREFfgets"><code>fgets</code></a>.
</p>
<p><strong>See also:</strong> <a href="#XREFfgets">fgets</a>, <a href="Formatted-Input.html#XREFfscanf">fscanf</a>, <a href="Binary-I_002fO.html#XREFfread">fread</a>, <a href="Opening-and-Closing-Files.html#XREFfopen">fopen</a>.
</p></dd></dl>


<span id="XREFfgets"></span><dl class="def">
<dt id="index-fgets"><span class="category">: </span><span><em><var>str</var> =</em> <strong>fgets</strong> <em>(<var>fid</var>)</em><a href='#index-fgets' class='copiable-anchor'> &para;</a></span></dt>
<dt id="index-fgets-1"><span class="category">: </span><span><em><var>str</var> =</em> <strong>fgets</strong> <em>(<var>fid</var>, <var>len</var>)</em><a href='#index-fgets-1' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Read characters from a file, stopping after a newline, or EOF,
or <var>len</var> characters have been read.
</p>
<p>The characters read, including the possible trailing newline, are returned
as a string.
</p>
<p>If <var>len</var> is omitted, <code>fgets</code> reads until the next newline
character.
</p>
<p>If there are no more characters to read, <code>fgets</code> returns -1.
</p>
<p>To read a line and discard the terminating newline,
see <a href="#XREFfgetl"><code>fgetl</code></a>.
</p>
<p><strong>See also:</strong> <a href="Simple-Output.html#XREFfputs">fputs</a>, <a href="#XREFfgetl">fgetl</a>, <a href="Formatted-Input.html#XREFfscanf">fscanf</a>, <a href="Binary-I_002fO.html#XREFfread">fread</a>, <a href="Opening-and-Closing-Files.html#XREFfopen">fopen</a>.
</p></dd></dl>


<span id="XREFfskipl"></span><dl class="def">
<dt id="index-fskipl"><span class="category">: </span><span><em><var>nlines</var> =</em> <strong>fskipl</strong> <em>(<var>fid</var>)</em><a href='#index-fskipl' class='copiable-anchor'> &para;</a></span></dt>
<dt id="index-fskipl-1"><span class="category">: </span><span><em><var>nlines</var> =</em> <strong>fskipl</strong> <em>(<var>fid</var>, <var>count</var>)</em><a href='#index-fskipl-1' class='copiable-anchor'> &para;</a></span></dt>
<dt id="index-fskipl-2"><span class="category">: </span><span><em><var>nlines</var> =</em> <strong>fskipl</strong> <em>(<var>fid</var>, Inf)</em><a href='#index-fskipl-2' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Read and skip <var>count</var> lines from the file specified by the file
descriptor <var>fid</var>.
</p>
<p><code>fskipl</code> discards characters until an end-of-line is encountered
exactly <var>count</var>-times, or until the end-of-file marker is found.
</p>
<p>If <var>count</var> is omitted, it defaults to 1.  <var>count</var> may also be
<code>Inf</code>, in which case lines are skipped until the end of the file.
This form is suitable for counting the number of lines in a file.
</p>
<p>Returns the number of lines skipped (end-of-line sequences encountered).
</p>
<p><strong>See also:</strong> <a href="#XREFfgetl">fgetl</a>, <a href="#XREFfgets">fgets</a>, <a href="Formatted-Input.html#XREFfscanf">fscanf</a>, <a href="Opening-and-Closing-Files.html#XREFfopen">fopen</a>.
</p></dd></dl>


</div>
<hr>
<div class="header">
<p>
Next: <a href="Formatted-Output.html">Formatted Output</a>, Previous: <a href="Simple-Output.html">Simple Output</a>, Up: <a href="C_002dStyle-I_002fO-Functions.html">C-Style I/O Functions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>