2e89c92e01d7cdff52776f7366eb889ac45093b4
[scilab.git] / scilab / modules / core / help / en_US / variables / who_user.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="who_user">
3     <refnamediv>
4         <refname>who_user</refname>
5         <refpurpose>listing of user's variables</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>varList = who_user([bPrint])</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>bPrint</term>
16                 <listitem>
17                     <para>
18                         Enable or disable screen outputs (Default: %t).
19                     </para>
20                 </listitem>
21             </varlistentry>
22         </variablelist>
23     </refsection>
24     <refsection>
25         <title>Return value</title>
26         <variablelist>
27             <varlistentry>
28                 <term>varList</term>
29                 <listitem>
30                     <para>
31                         Column vector of user's variables or [] if user does not have variable.
32                     </para>
33                 </listitem>
34             </varlistentry>
35         </variablelist>
36     </refsection>
37     <refsection>
38         <title>Description</title>
39         <para>
40             <literal>who_user</literal> displays and/or returns user's variable names.
41         </para>
42     </refsection>
43     <refsection>
44         <title>Examples</title>
45         <programlisting role="code_scilab">
46             <![CDATA[ 
47 clear;
48 who_user()
49 who_user(%t)
50 who_user(%f)
51 a = 1;
52 b = 2;
53 who_user()
54 who_user(%t)
55 who_user(%f)
56 clear;
57  ]]>
58         </programlisting>
59     </refsection>
60     <refsection role="see also">
61         <title>See Also</title>
62         <simplelist type="inline">
63             <member>
64                 <link linkend="whos">whos</link>
65             </member>
66             <member>
67                 <link linkend="who">who</link>
68             </member>
69         </simplelist>
70     </refsection>
71     <refsection>
72         <title>History</title>
73         <revhistory>
74             <revision>
75                 <revnumber>5.4.0</revnumber>
76                 <revremark>who_user can now return user's variable names in a column vector of character strings.</revremark>
77             </revision>
78         </revhistory>
79     </refsection>
80 </refentry>