← 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/mclose.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/mclose.xml
12
12
 *
13
13
 -->
14
14
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mclose">
15
 
  <refnamediv>
16
 
    <refname>mclose</refname>
17
 
    <refpurpose>closes an opened file</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>
22
 
      err=mclose([fd])
23
 
      mclose('all')
24
 
    </synopsis>
25
 
  </refsynopsisdiv>
26
 
  <refsection>
27
 
    <title>Arguments</title>
28
 
    <variablelist>
29
 
      <varlistentry>
30
 
        <term>fd</term>
31
 
        <listitem>
32
 
          <para>
33
 
            a scalar: the <varname>fd</varname> parameter returned by the function <function>mopen</function> is used as a file descriptor.
34
 
          </para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>err</term>
39
 
        <listitem>
40
 
          <para>a scalar: an error indicator.</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
    </variablelist>
44
 
  </refsection>
45
 
  <refsection>
46
 
    <title>Description</title>
47
 
    <para>
48
 
      <function>mclose</function> must be used to close a file opened by 
49
 
      <function>mopen</function>. If <varname>fd</varname> is omitted 
50
 
      <function>mclose</function> closes the last opend file.
51
 
    </para>
52
 
    <para>
53
 
      <code>mclose('all')</code> closes all files opened by 
54
 
      <code>file('open',..)</code> or <function>mopen</function>. 
55
 
      <warning>
56
 
        Be careful with this use of <function>mclose</function> because when 
57
 
        it is used inside a Scilab script file, it also closes the script and 
58
 
        Scilab will not execute commands written after 
59
 
        <code>mclose('all')</code>.
60
 
      </warning>
61
 
    </para>
62
 
  </refsection>
63
 
  <refsection role="see also">
64
 
    <title>See Also</title>
65
 
    <simplelist type="inline">
66
 
      <member>
67
 
        <link linkend="meof">meof</link>
68
 
      </member>
69
 
      <member>
70
 
        <link linkend="mfprintf">mfprintf</link>
71
 
      </member>
72
 
      <member>
73
 
        <link linkend="fprintfMat">fprintfMat</link>
74
 
      </member>
75
 
      <member>
76
 
        <link linkend="mfscanf">mfscanf</link>
77
 
      </member>
78
 
      <member>
79
 
        <link linkend="fscanfMat">fscanfMat</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="mget">mget</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="mgetl">mgetl</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="mgetstr">mgetstr</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="mopen">mopen</link>
92
 
      </member>
93
 
      <member>
94
 
        <link linkend="mprintf">mprintf</link>
95
 
      </member>
96
 
      <member>
97
 
        <link linkend="mput">mput</link>
98
 
      </member>
99
 
      <member>
100
 
        <link linkend="mputl">mputl</link>
101
 
      </member>
102
 
      <member>
103
 
        <link linkend="mputstr">mputstr</link>
104
 
      </member>
105
 
      <member>
106
 
        <link linkend="mseek">mseek</link>
107
 
      </member>
108
 
      <member>
109
 
        <link linkend="mtell">mtell</link>
110
 
      </member>
111
 
      <member>
112
 
        <link linkend="file">file</link>
113
 
      </member>
114
 
      <member>
115
 
        <link linkend="mdelete">mdelete</link>
116
 
      </member>
117
 
    </simplelist>
118
 
  </refsection>
 
15
    <refnamediv>
 
16
        <refname>mclose</refname>
 
17
        <refpurpose>closes an opened file</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>
 
22
            err = mclose([fd])
 
23
            mclose('all')
 
24
        </synopsis>
 
25
    </refsynopsisdiv>
 
26
    <refsection>
 
27
        <title>Arguments</title>
 
28
        <variablelist>
 
29
            <varlistentry>
 
30
                <term>fd</term>
 
31
                <listitem>
 
32
                    <para>
 
33
                        a scalar: the <varname>fd</varname> parameter returned by the function <function>mopen</function> is used as a file descriptor.
 
34
                    </para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>err</term>
 
39
                <listitem>
 
40
                    <para>a scalar: an error indicator.</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
        </variablelist>
 
44
    </refsection>
 
45
    <refsection>
 
46
        <title>Description</title>
 
47
        <para>
 
48
            <function>mclose</function> must be used to close a file opened by 
 
49
            <function>mopen</function>. If <varname>fd</varname> is omitted 
 
50
            <function>mclose</function> closes the last opend file.
 
51
        </para>
 
52
        <para>
 
53
            <code>mclose('all')</code> closes all files opened by 
 
54
            <code>file('open',..)</code> or <function>mopen</function>. 
 
55
            <caution>
 
56
                Be careful with this use of <function>mclose</function> because when 
 
57
                it is used inside a Scilab script file, it also closes the script and 
 
58
                Scilab will not execute commands written after 
 
59
                <code>mclose('all')</code>.
 
60
            </caution>
 
61
        </para>
 
62
    </refsection>
 
63
    <refsection role="see also">
 
64
        <title>See Also</title>
 
65
        <simplelist type="inline">
 
66
            <member>
 
67
                <link linkend="meof">meof</link>
 
68
            </member>
 
69
            <member>
 
70
                <link linkend="mfprintf">mfprintf</link>
 
71
            </member>
 
72
            <member>
 
73
                <link linkend="fprintfMat">fprintfMat</link>
 
74
            </member>
 
75
            <member>
 
76
                <link linkend="mfscanf">mfscanf</link>
 
77
            </member>
 
78
            <member>
 
79
                <link linkend="fscanfMat">fscanfMat</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="mget">mget</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="mgetl">mgetl</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="mgetstr">mgetstr</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="mopen">mopen</link>
 
92
            </member>
 
93
            <member>
 
94
                <link linkend="mprintf">mprintf</link>
 
95
            </member>
 
96
            <member>
 
97
                <link linkend="mput">mput</link>
 
98
            </member>
 
99
            <member>
 
100
                <link linkend="mputl">mputl</link>
 
101
            </member>
 
102
            <member>
 
103
                <link linkend="mputstr">mputstr</link>
 
104
            </member>
 
105
            <member>
 
106
                <link linkend="mseek">mseek</link>
 
107
            </member>
 
108
            <member>
 
109
                <link linkend="mtell">mtell</link>
 
110
            </member>
 
111
            <member>
 
112
                <link linkend="file">file</link>
 
113
            </member>
 
114
            <member>
 
115
                <link linkend="mdelete">mdelete</link>
 
116
            </member>
 
117
        </simplelist>
 
118
    </refsection>
119
119
</refentry>