blob: b261053c06224da8c06b5afcab681bf7b80c4daf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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>
|
