← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/fileio/help/en_US/mgetstr.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/fileio/help/en_US/mgetstr.xml
13
13
 *
14
14
 -->
15
15
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="mgetstr" xml:lang="en">
16
 
  <refnamediv>
17
 
    <refname>mgetstr</refname>
18
 
    <refpurpose>reads a character string from a file</refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>str = mgetstr(n, [fd])</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>n</term>
29
 
        <listitem>
30
 
          <para>non-negative integer: how many characters should be
31
 
            read.
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>fd</term>
37
 
        <listitem>
38
 
          <para>
39
 
            an integer: file descriptor as returned by 
40
 
            <link linkend="mopen">mopen</link>: where characters should be read. The value <literal>-1</literal> stands for the last opened file and is the default.
41
 
          </para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
      <varlistentry>
45
 
        <term>str</term>
46
 
        <listitem>
47
 
          <para>the character string to be read.</para>
48
 
        </listitem>
49
 
      </varlistentry>
50
 
    </variablelist>
51
 
  </refsection>
52
 
  <refsection>
53
 
    <title>Description</title>
54
 
    <para>
55
 
      The <function>mgetstr</function> function attempts to read up
56
 
      to <varname>n</varname> characters from a file. If end of file is
57
 
      reached before <varname>n</varname> characters are read,
58
 
      <function>mgetstr</function> returns the properly read values
59
 
      only. As a consequence, when the read cursor is already at the end
60
 
      of the file when <function>mgetstr</function> is called, it returns
61
 
      an empty string no matter what value is provided for
62
 
      <varname>n</varname>.
63
 
    </para>
64
 
  </refsection>
65
 
  <refsection>
66
 
    <title>Examples</title>
67
 
    <programlisting role="example"><![CDATA[
 
16
    <refnamediv>
 
17
        <refname>mgetstr</refname>
 
18
        <refpurpose>reads a character string from a file</refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>str = mgetstr(n, [fd])</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>n</term>
 
29
                <listitem>
 
30
                    <para>non-negative integer: how many characters should be
 
31
                        read.
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>fd</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        an integer: file descriptor as returned by 
 
40
                        <link linkend="mopen">mopen</link>: where characters should be read. The value <literal>-1</literal> stands for the last opened file and is the default.
 
41
                    </para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
            <varlistentry>
 
45
                <term>str</term>
 
46
                <listitem>
 
47
                    <para>the character string to be read.</para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
        </variablelist>
 
51
    </refsection>
 
52
    <refsection>
 
53
        <title>Description</title>
 
54
        <para>
 
55
            The <function>mgetstr</function> function attempts to read up
 
56
            to <varname>n</varname> characters from a file. If end of file is
 
57
            reached before <varname>n</varname> characters are read,
 
58
            <function>mgetstr</function> returns the properly read values
 
59
            only. As a consequence, when the read cursor is already at the end
 
60
            of the file when <function>mgetstr</function> is called, it returns
 
61
            an empty string no matter what value is provided for
 
62
            <varname>n</varname>.
 
63
        </para>
 
64
    </refsection>
 
65
    <refsection>
 
66
        <title>Examples</title>
 
67
        <programlisting role="example"><![CDATA[
68
68
      fn = SCI + '/ACKNOWLEDGEMENTS'; // absolute path to some file
69
69
      details = fileinfo(fn);         // retrieve file details
70
70
      len = details(1);               // get file length
80
80
      length(str4)                    // empty string
81
81
      mclose(fd);                     // close file descriptor
82
82
  ]]></programlisting>
83
 
  </refsection>
84
 
  <refsection role="see also">
85
 
    <title>See Also</title>
86
 
    <simplelist type="inline">
87
 
      <member>
88
 
        <link linkend="mclose">mclose</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="meof">meof</link>
92
 
      </member>
93
 
      <member>
94
 
        <link linkend="mfprintf">mfprintf</link>
95
 
      </member>
96
 
      <member>
97
 
        <link linkend="fprintfMat">fprintfMat</link>
98
 
      </member>
99
 
      <member>
100
 
        <link linkend="mfscanf">mfscanf</link>
101
 
      </member>
102
 
      <member>
103
 
        <link linkend="fscanfMat">fscanfMat</link>
104
 
      </member>
105
 
      <member>
106
 
        <link linkend="mget">mget</link>
107
 
      </member>
108
 
      <member>
109
 
        <link linkend="mopen">mopen</link>
110
 
      </member>
111
 
      <member>
112
 
        <link linkend="mprintf">mprintf</link>
113
 
      </member>
114
 
      <member>
115
 
        <link linkend="mput">mput</link>
116
 
      </member>
117
 
      <member>
118
 
        <link linkend="mputstr">mputstr</link>
119
 
      </member>
120
 
      <member>
121
 
        <link linkend="mseek">mseek</link>
122
 
      </member>
123
 
      <member>
124
 
        <link linkend="mtell">mtell</link>
125
 
      </member>
126
 
      <member>
127
 
        <link linkend="mdelete">mdelete</link>
128
 
      </member>
129
 
      <member>"Input/Output functions" section</member>
130
 
      <!-- TODO: link to "Input/Output functions" index page -->
131
 
      <!-- next link does not work when reading doc in scilab -->
132
 
      <!-- <member><link linkend="section_efa4cbf5c15e166f34901f827390e756">Input/Output functions</link></member> -->
133
 
    </simplelist>
134
 
  </refsection>
 
83
    </refsection>
 
84
    <refsection role="see also">
 
85
        <title>See Also</title>
 
86
        <simplelist type="inline">
 
87
            <member>
 
88
                <link linkend="mclose">mclose</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="meof">meof</link>
 
92
            </member>
 
93
            <member>
 
94
                <link linkend="mfprintf">mfprintf</link>
 
95
            </member>
 
96
            <member>
 
97
                <link linkend="fprintfMat">fprintfMat</link>
 
98
            </member>
 
99
            <member>
 
100
                <link linkend="mfscanf">mfscanf</link>
 
101
            </member>
 
102
            <member>
 
103
                <link linkend="fscanfMat">fscanfMat</link>
 
104
            </member>
 
105
            <member>
 
106
                <link linkend="mget">mget</link>
 
107
            </member>
 
108
            <member>
 
109
                <link linkend="mopen">mopen</link>
 
110
            </member>
 
111
            <member>
 
112
                <link linkend="mprintf">mprintf</link>
 
113
            </member>
 
114
            <member>
 
115
                <link linkend="mput">mput</link>
 
116
            </member>
 
117
            <member>
 
118
                <link linkend="mputstr">mputstr</link>
 
119
            </member>
 
120
            <member>
 
121
                <link linkend="mseek">mseek</link>
 
122
            </member>
 
123
            <member>
 
124
                <link linkend="mtell">mtell</link>
 
125
            </member>
 
126
            <member>
 
127
                <link linkend="mdelete">mdelete</link>
 
128
            </member>
 
129
            <member>"Input/Output functions" section</member>
 
130
            <!-- TODO: link to "Input/Output functions" index page -->
 
131
            <!-- next link does not work when reading doc in scilab -->
 
132
            <!-- <member><link linkend="section_efa4cbf5c15e166f34901f827390e756">Input/Output functions</link></member> -->
 
133
        </simplelist>
 
134
    </refsection>
135
135
</refentry>