summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/sym_setStrParam.html
blob: 2fa67cae0f00765a1e23f58d29548a2d7c76b1c7 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>sym_setStrParam</title>
    <style type="text/css" media="all">
      @import url("scilab_code.css");
      @import url("xml_code.css");
      @import url("c_code.css");
      @import url("style.css");
    </style>
  </head>
  <body>
    <div class="manualnavbar">
    <table width="100%"><tr>
      <td width="30%">
    	<span class="previous"><a href="sym_setPrimalBound.html">&lt;&lt; sym_setPrimalBound</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_508f0b211d17ea6769714cc144e6b731.html">Symphony Native Functions</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="sym_setVarLower.html">sym_setVarLower &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path"><a href="index.html">FOSSEE Optimization Toolbox</a> &gt;&gt; <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">FOSSEE Optimization Toolbox</a> &gt; <a href="section_508f0b211d17ea6769714cc144e6b731.html">Symphony Native Functions</a> &gt; sym_setStrParam</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">sym_setStrParam</h1>
		<p class="refpurpose">This routine is used to set a string type parameter.</p></div>

	<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
		<div class="synopsis"><pre><span class="functionid">sym_setStrParam</span><span class="default">(</span><span class="default">key</span><span class="default">,</span><span class="default">value</span><span class="default">)</span></pre></div></div>

	<div class="refsection"><h3 class="title">Description</h3></div>

	<div class="refsection"><h3 class="title">Arguments</h3>

		<dl><dt><span class="term">key</span>
				<dd><p class="para">The name of the string type parameter to be set. Note: should be given within &#0034; &#0034;</p></dd></dt>
			<dt><span class="term">value</span>
				<dd><p class="para">New value of the corresponding string parameter. Note: should be given within &#0034; &#0034;</p></dd></dt></dl></div>

	<div class="refsection"><h3 class="title">Return value</h3>
		
		<p class="para">Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the string parameter was unsuccessful due to invalid inputs</p></div>

	<div class="refsection"><h3 class="title">Examples</h3>

		<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setStrParam</span><span class="scilabopenclose">(</span><span class="scilabstring">&#0034;</span><span class="scilabstring">source_path</span><span class="scilabstring">&#0034;</span><span class="scilabdefault">,</span><span class="scilabstring">&#0034;</span><span class="scilabstring">.</span><span class="scilabstring">.</span><span class="scilabstring">&#0034;</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>

	<div class="refsection"><h3 class="title">Authors</h3>

		<ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div>
    <br />

    <div class="manualnavbar">
    <table width="100%">
    <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
      <td width="30%">
    	<span class="previous"><a href="sym_setPrimalBound.html">&lt;&lt; sym_setPrimalBound</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_508f0b211d17ea6769714cc144e6b731.html">Symphony Native Functions</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="sym_setVarLower.html">sym_setVarLower &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>