changequote({,})
define({_TITLE_},{Varkon MBS Programmers manual})
define({_SUBTITLE_},{- substr - Function})
define({_INDEXLINK_},{<a href="striindx.htm">index</a>})
define({_STYLE_},{../varkonstyle.css})
include(../../include/header.inc)


<h1>substr - Function</h1>

<h2>Description</h2>

<p>
Creates a new (sub-) string by copying one or more characters from an existing string.
</p>

<h2>Syntax</h2>

<pre>
  s2:={substr}(s1, start, count);

  string s2;
  string s1;
  int    start;
  int    count;
</pre>

<h2>Principal parameters</h2>

<table>
<tr>
<td>s1</td>
<td>- The original string.</td>
</tr>
<tr>
<td>start</td>
<td>- Position of first character to copy, 1&lt;= start &lt;=132.</td>
</tr>
</table>

<h2>Optional parameters</h2>

<table>
<tr>
<td>count</td>
<td>- Number of characters to copy, default is the rest of the string.</td>
</tr>
</table>

<h2>Return value</h2>

<p>A STRING value equal to the new string.</p>

<h2>Examples</h2>

<pre>
  s2:={substr}(&quot;ABCDE&quot;,2,3);   ! Equal to s2:=&quot;BCD&quot;;

  s2:={substr}(&quot;ABCDE&quot;,4,1);   ! Equal to s2:=&quot;D&quot;;

  s2:={substr}(&quot;ABCDE&quot;,3);     ! Equal to s2:=&quot;CDE&quot;;

  s2:={substr}(&quot;ABCDE&quot;,1);     ! Equal to s2:=&quot;ABCDE&quot;;
</pre>

include(../../include/svnversion.inc)
include(../../include/footer.inc)