summaryrefslogtreecommitdiff
path: root/help/en_US/sym_setIntParam.xml
blob: e20dfb59fbc9c007e58a00e757b3251f735abf5a (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
62
63
64
65
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="sym_setIntParam" 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_setIntParam</refname>
		<refpurpose>This routine is used to set an integer type parameter.</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<title>Calling Sequence</title>
		<synopsis>sym_setIntParam(key,value)</synopsis>
	</refsynopsisdiv>

	<refsection>
		<title>Description</title>


	</refsection>

	<refsection>
		<title>Arguments</title>

		<variablelist>
			<varlistentry>
				<term>key</term>
				<listitem><para>The name of the parameter to be set. Note:should be given within " "</para></listitem>
			</varlistentry>
			<varlistentry>
				<term>value</term>
				<listitem><para>New value of the corresponding integer parameter</para></listitem>
			</varlistentry>
		</variablelist>

	</refsection>

	<refsection>
		<title>Return value</title>
		
		<para>Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the integer parameter was unsuccessful due to invalid inputs</para>

	</refsection>

	<refsection>
		<title>Examples</title>

		<programlisting role="example">status=sym_setIntParam("verbosity",5)</programlisting>

	</refsection>

	<refsection>
		<title>Authors</title>

		<simplelist type="vert">
			<member>Iswarya Hariharan</member>

		</simplelist>
	</refsection>
</refentry>