summaryrefslogtreecommitdiff
path: root/opcodes/strget.xml
blob: 15f188d3e603db380cbac620d4e63424488ff38b (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
<refentry id="strget">
<indexterm id="Indexstrget"><primary>strget</primary></indexterm>
  <refentryinfo><title>Strings:Definition</title></refentryinfo>
  <refmeta>
    <refentrytitle>strget</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>strget</refname>
    <refpurpose>
      Set string variable to value from strset table or string p-field
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>strget</emphasis> sets a string variable at initialization time to the value stored in <link linkend="strset"><citetitle>strset</citetitle></link> table at the specified index, or a string p-field from the score. If there is no string defined for the index, the variable is set to an empty string.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>Sdst <command>strget</command> indx</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>indx</emphasis> -- strset index, or score p-field
    </para>

    <para>
      <emphasis>Sdst</emphasis> -- destination string variable
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the strget opcode. It uses the file <ulink url="examples/strget.csd"><citetitle>strget.csd</citetitle></ulink>.
      <example>
        <title>Example of the strget opcode.</title>
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/strget.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>See also</title>
    <para><link linkend="strset"><citetitle>strset</citetitle></link>
    </para>
  </refsect1>


  <refsect1>
    <title>Credits</title>
    <para>Author: Istvan Varga</para>
    <para>2005</para>
  </refsect1>
</refentry>