summaryrefslogtreecommitdiff
path: root/help/en_US/Symphony Native Function/sym_getStrParam.xml
diff options
context:
space:
mode:
authorHarpreet2015-09-01 14:21:55 +0530
committerHarpreet2015-09-01 14:21:55 +0530
commited526ee458eab28367de030f450838a038f2ed10 (patch)
treea696611f362a43d215f53b1b074da49a78b5e2e1 /help/en_US/Symphony Native Function/sym_getStrParam.xml
parentd8e0fa36cb1bd4e00307792008aca1d56043b15a (diff)
downloadFOSSEE-Optimization-toolbox-ed526ee458eab28367de030f450838a038f2ed10.tar.gz
FOSSEE-Optimization-toolbox-ed526ee458eab28367de030f450838a038f2ed10.tar.bz2
FOSSEE-Optimization-toolbox-ed526ee458eab28367de030f450838a038f2ed10.zip
Styling help
Diffstat (limited to 'help/en_US/Symphony Native Function/sym_getStrParam.xml')
-rw-r--r--help/en_US/Symphony Native Function/sym_getStrParam.xml61
1 files changed, 61 insertions, 0 deletions
diff --git a/help/en_US/Symphony Native Function/sym_getStrParam.xml b/help/en_US/Symphony Native Function/sym_getStrParam.xml
new file mode 100644
index 0000000..b261053
--- /dev/null
+++ b/help/en_US/Symphony Native Function/sym_getStrParam.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry version="5.0-subset Scilab" xml:id="sym_getStrParam" 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_getStrParam</refname>
+ <refpurpose>This routine is used to get the value of a string type parameter.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>sym_getStrParam(key)</synopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+
+ </refsection>
+
+ <refsection>
+ <title>Arguments</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>key</term>
+ <listitem><para>The name of the strung 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_getStrParam("source_path")</programlisting>
+
+ </refsection>
+
+ <refsection>
+ <title>Authors</title>
+
+ <simplelist type="vert">
+ <member>Iswarya Hariharan</member>
+
+ </simplelist>
+ </refsection>
+</refentry>
+