83182fbb926e1c81970e608d0346f68b4990fdd3
[scilab.git] / scilab / modules / core / help / en_US / variables / isglobal.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="isglobal">
3     <refnamediv>
4         <refname>isglobal</refname>
5         <refpurpose>check if a variable is global</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>t = isglobal(x)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>x</term>
16                 <listitem>
17                     <para>any variable</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>t</term>
22                 <listitem>
23                     <para>a boolean</para>
24                 </listitem>
25             </varlistentry>
26         </variablelist>
27     </refsection>
28     <refsection>
29         <title>Description</title>
30         <para>
31             <code>isglobal(x)</code> returns <emphasis>true</emphasis> if <varname>x</varname> has been declared to be a global
32             variable and <emphasis>false</emphasis> otherwise.
33         </para>
34     </refsection>
35     <refsection>
36         <title>Examples</title>
37         <programlisting role="example"><![CDATA[
38 isglobal(1)
39 global a
40 isglobal(a)
41  ]]></programlisting>
42     </refsection>
43     <refsection role="see also">
44         <title>See also</title>
45         <simplelist type="inline">
46             <member>
47                 <link linkend="global">global</link>
48             </member>
49             <member>
50                 <link linkend="clearglobal">clearglobal</link>
51             </member>
52             <member>
53                 <link linkend="who">who</link>
54             </member>
55         </simplelist>
56     </refsection>
57 </refentry>