summaryrefslogtreecommitdiff
path: root/help/en_US/sym_getIntParam.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/sym_getIntParam.xml')
-rw-r--r--help/en_US/sym_getIntParam.xml61
1 files changed, 61 insertions, 0 deletions
diff --git a/help/en_US/sym_getIntParam.xml b/help/en_US/sym_getIntParam.xml
new file mode 100644
index 0000000..a6626af
--- /dev/null
+++ b/help/en_US/sym_getIntParam.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry version="5.0-subset Scilab" xml:id="sym_getIntParam" 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_getIntParam</refname>
+ <refpurpose>This routine is used to get the value of an integer type parameter.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>sym_getIntParam(key)</synopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+
+ </refsection>
+
+ <refsection>
+ <title>Arguments</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>key</term>
+ <listitem><para>The name of the integer parameter whose value has to be retrieved. Note: should be given within " "</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsection>
+
+ <refsection>
+ <title>Return value</title>
+
+ <para>Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function</para>
+
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting role="example">status=sym_getIntParam("verbosity")</programlisting>
+
+ </refsection>
+
+ <refsection>
+ <title>Authors</title>
+
+ <simplelist type="vert">
+ <member>Iswarya Hariharan</member>
+
+ </simplelist>
+ </refsection>
+</refentry>
+