← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/matio/help/en_US/matfile_varwrite.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/matio/help/en_US/matfile_varwrite.xml
11
11
    *
12
12
    -->
13
13
<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="matfile_varwrite">
14
 
  <refnamediv>
15
 
    <refname>matfile_varwrite</refname>
16
 
    <refpurpose>Write a variable in a Matlab V5 binary MAT-file.</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>status = matfile_varreadnext(fd, name, value, compressionflag)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>fd</term>
27
 
        <listitem>
28
 
          <para>
29
 
            Real: file descriptor (returned by <link linkend="matfile_open">matfile_open</link>).
30
 
          </para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>name</term>
35
 
        <listitem>
36
 
          <para>String: name of the variable to write in the file.</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>value</term>
41
 
        <listitem>
42
 
          <para>Any Scilab type: value of the variable to write in the file.</para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
      <varlistentry>
46
 
        <term>compressionflag</term>
47
 
        <listitem>
48
 
          <para>
49
 
            Boolean: indicate if data compression has to be used (flag equaled to <emphasis>%T</emphasis>) or not.
50
 
          </para>
51
 
        </listitem>
52
 
      </varlistentry>
53
 
      <varlistentry>
54
 
        <term>status</term>
55
 
        <listitem>
56
 
          <para>
57
 
            Boolean: <emphasis>%T</emphasis> if writing succeeds, <emphasis>%F</emphasis> otherwise.
58
 
          </para>
59
 
        </listitem>
60
 
      </varlistentry>
61
 
    </variablelist>
62
 
  </refsection>
63
 
  <refsection>
64
 
    <title>Description</title>
65
 
    <para>
66
 
      Writes a variable in a Matlab binary MAT-file opened by <link linkend="matfile_open">matfile_open</link>.
67
 
    </para>
68
 
  </refsection>
69
 
  <refsection role="see also">
70
 
    <title>See Also</title>
71
 
    <simplelist type="inline">
72
 
      <member>
73
 
        <link linkend="matfile_open">matfile_open</link>
74
 
      </member>
75
 
      <member>
76
 
        <link linkend="matfile_close">matfile_close</link>
77
 
      </member>
78
 
      <member>
79
 
        <link linkend="matfile_varreadnext">matfile_varreadnext</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="matfile_listvar">matfile_listvar</link>
83
 
      </member>
84
 
    </simplelist>
85
 
  </refsection>
86
 
  <refsection>
87
 
    <title>Bibliography</title>
88
 
    <para>
89
 
      This function uses MATIO library (
90
 
      <literal>
91
 
        <ulink url="http://sourceforge.net/projects/matio/">http://sourceforge.net/projects/matio/</ulink>
92
 
      </literal>
93
 
      ).
94
 
    </para>
95
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>matfile_varwrite</refname>
 
16
        <refpurpose>Write a variable in a Matlab V5 binary MAT-file.</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>status = matfile_varreadnext(fd, name, value, compressionflag)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>fd</term>
 
27
                <listitem>
 
28
                    <para>
 
29
                        Real: file descriptor (returned by <link linkend="matfile_open">matfile_open</link>).
 
30
                    </para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>name</term>
 
35
                <listitem>
 
36
                    <para>String: name of the variable to write in the file.</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>value</term>
 
41
                <listitem>
 
42
                    <para>Any Scilab type: value of the variable to write in the file.</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>compressionflag</term>
 
47
                <listitem>
 
48
                    <para>
 
49
                        Boolean: indicate if data compression has to be used (flag equaled to <emphasis>%T</emphasis>) or not.
 
50
                    </para>
 
51
                </listitem>
 
52
            </varlistentry>
 
53
            <varlistentry>
 
54
                <term>status</term>
 
55
                <listitem>
 
56
                    <para>
 
57
                        Boolean: <emphasis>%T</emphasis> if writing succeeds, <emphasis>%F</emphasis> otherwise.
 
58
                    </para>
 
59
                </listitem>
 
60
            </varlistentry>
 
61
        </variablelist>
 
62
    </refsection>
 
63
    <refsection>
 
64
        <title>Description</title>
 
65
        <para>
 
66
            Writes a variable in a Matlab binary MAT-file opened by <link linkend="matfile_open">matfile_open</link>.
 
67
        </para>
 
68
    </refsection>
 
69
    <refsection role="see also">
 
70
        <title>See Also</title>
 
71
        <simplelist type="inline">
 
72
            <member>
 
73
                <link linkend="matfile_open">matfile_open</link>
 
74
            </member>
 
75
            <member>
 
76
                <link linkend="matfile_close">matfile_close</link>
 
77
            </member>
 
78
            <member>
 
79
                <link linkend="matfile_varreadnext">matfile_varreadnext</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="matfile_listvar">matfile_listvar</link>
 
83
            </member>
 
84
        </simplelist>
 
85
    </refsection>
 
86
    <refsection>
 
87
        <title>Bibliography</title>
 
88
        <para>
 
89
            This function uses MATIO library (
 
90
            <literal>
 
91
                <ulink url="http://sourceforge.net/projects/matio/">http://sourceforge.net/projects/matio/</ulink>
 
92
            </literal>
 
93
            ).
 
94
        </para>
 
95
    </refsection>
96
96
</refentry>