bab0e10fb8c87d9f16329f63addae324076ab06e
[scilab.git] / scilab / modules / fileio / help / en_US / mputl.xml
1 <?xml version="1.0" encoding="windows-1251"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA - Serge STEER
5  * ...
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <refentry version="5.0-subset Scilab" xml:id="mputl" xml:lang="en"
15           xmlns="http://docbook.org/ns/docbook"
16           xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg"
18           xmlns:ns3="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML"
20           xmlns:db="http://docbook.org/ns/docbook">
21   <info>
22     <pubdate>$LastChangedDate$</pubdate>
23   </info>
24
25   <refnamediv>
26     <refname>mputl</refname>
27
28     <refpurpose>writes strings in an ascii file</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>r = mputl(txt ,file_desc)</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>r</term>
43
44         <listitem>
45           <para>returns %t or %f to check if function has correctly written on
46           the file.</para>
47         </listitem>
48       </varlistentry>
49
50       <varlistentry>
51         <term>file_desc</term>
52
53         <listitem>
54           <para>A character string giving the name of the file or a logical
55           unit returned by mopen.</para>
56
57           <para>OBSOLETE : If omitted, lines are written in the last file
58           opened by mopen.</para>
59         </listitem>
60       </varlistentry>
61
62       <varlistentry>
63         <term>txt</term>
64
65         <listitem>
66           <para>a vector of strings.</para>
67         </listitem>
68       </varlistentry>
69     </variablelist>
70   </refsection>
71
72   <refsection>
73     <title>Description</title>
74
75     <para><literal>mputl</literal> function allows to write a vector of
76     strings as a sequence of lines in an ascii file.</para>
77   </refsection>
78
79   <refsection>
80     <title>Examples</title>
81
82     <programlisting role="example"><![CDATA[ 
83 fd = mopen(TMPDIR+'/text_mputl.txt','wt');
84 mputl('Hello World',fd);
85 mclose(fd);
86
87 fd = mopen(TMPDIR+'/text_mputl.txt','rt');
88 disp(mgetl(fd));
89 mclose(fd);
90  ]]></programlisting>
91   </refsection>
92
93   <refsection>
94     <title>See Also</title>
95
96     <simplelist type="inline">
97       <member><link linkend="mget">mget</link></member>
98
99       <member><link linkend="mgetl">mgetl</link></member>
100
101       <member><link linkend="mclose">mclose</link></member>
102
103       <member><link linkend="mfprintf">mfprintf</link></member>
104
105       <member><link linkend="mput">mput</link></member>
106
107       <member><link linkend="mputstr">mputstr</link></member>
108
109       <member><link linkend="mopen">mopen</link></member>
110
111       <member><link linkend="write">write</link></member>
112     </simplelist>
113   </refsection>
114
115   <refsection>
116     <title>Authors</title>
117
118     <para>S. Steer</para>
119      <para>Allan CORNET</para>
120   </refsection>
121 </refentry>