summaryrefslogtreecommitdiff
path: root/help/en_US/sym_isEnvActive.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/sym_isEnvActive.xml')
-rw-r--r--help/en_US/sym_isEnvActive.xml57
1 files changed, 57 insertions, 0 deletions
diff --git a/help/en_US/sym_isEnvActive.xml b/help/en_US/sym_isEnvActive.xml
new file mode 100644
index 0000000..b47e28b
--- /dev/null
+++ b/help/en_US/sym_isEnvActive.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry version="5.0-subset Scilab" xml:id="sym_isEnvActive" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ns3="http://www.w3.org/1999/xhtml"
+ xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:db="http://docbook.org/ns/docbook">
+
+ <refnamediv>
+ <refname>sym_isEnvActive</refname>
+ <refpurpose>Check if Symphony environment is active</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>sym_isEnvActive()</synopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Check if Symphony environment is active (open). Most Symphony functions will require the environment to be open.</para>
+
+ </refsection>
+
+ <refsection>
+ <title>Arguments</title>
+
+ <para>This function takes no arguments</para>
+
+ </refsection>
+
+ <refsection>
+ <title>Return value</title>
+
+ <para>Returns 1 if the environment is active and 0 otherwise</para>
+
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting role="example">sym_isEnvActive()</programlisting>
+
+ </refsection>
+
+ <refsection>
+ <title>Authors</title>
+
+ <simplelist type="vert">
+ <member>Keyur Joshi</member>
+
+ </simplelist>
+ </refsection>
+</refentry>
+