summaryrefslogtreecommitdiffstats
path: root/scilab/modules/data_structures/help/en_US/fieldnames.xml
blob: 6e5a0d5f273f0a8b98210ff8bbc3efc407d18bb2 (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA
 * Copyright (C) 2010 - Digiteo - Vincent LIARD
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<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="fieldnames">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>fieldnames</refname>
    <refpurpose>get a tlist, mlist or struct fields names</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>f = fieldnames(lst)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>lst</term>
        <listitem>
          <para>A tlist, mlist or struct variable.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>f</term>
        <listitem>
          <para>Strings column vector of fields names.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
      The <literal>fieldnames</literal> function returns field names
      of a tlist, mlist or struct. <literal>fieldnames</literal>
      does not work on cells.
    </para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example">
fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
obj.x = 3;
obj.y = 3;
fieldnames(obj)
    </programlisting>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="extraction">extraction</link>
      </member>  
      <member>
        <link linkend="getfield">getfield</link>
      </member>
      <member>
        <link linkend="tlist">tlist</link>
      </member>
      <member>
        <link linkend="mlist">mlist</link>
      </member>
      <member>
        <link linkend="mlist">struct</link>
      </member>
    </simplelist>
  </refsection>
</refentry>