summaryrefslogtreecommitdiff
path: root/opcodes/strsubk.xml
blob: b0acfce1921fd1dfb185aa43d069c5e7eb100d7e (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
<refentry id="strsubk">
<indexterm id="Indexstrsubk"><primary>strsubk</primary></indexterm>
  <refentryinfo><title>Strings:Manipulation</title></refentryinfo>
  <refmeta>
    <refentrytitle>strsubk</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>strsubk</refname>
    <refpurpose>
      Extract a substring
          </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Return a substring of the source string. strsubk runs both at init and
      performance time.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>Sdst <command>strsubk</command> Ssrc, kstart, kend</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>

    <para>
      <emphasis>kstart</emphasis>
      -- start position in Ssrc, counting from 0.
      A negative value means the end of the string.
    </para>

    <para>
      <emphasis>kend</emphasis>
      -- end position in Ssrc, counting from 0.
      A negative value means the end of the string. If kend is less than
      kstart, the output is reversed.
    </para>
  </refsect1>

  <refsect1>
	  <title>See also</title>
	  <para><link linkend="strsub"><citetitle>strsub</citetitle></link></para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Istvan Varga</member>
        <member>2006</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>