summaryrefslogtreecommitdiff
path: root/opcodes/ftfree.xml
blob: 1ea726341b0e0129db5d438e45a03133bc04f40b (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
<refentry id="ftfree">
<indexterm id="Indexftfree"><primary>ftfree</primary></indexterm>
  <refentryinfo><title>Table Control</title></refentryinfo>
  <refmeta>
    <refentrytitle>ftfree</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>ftfree</refname>
    <refpurpose>
      Deletes function table.
          </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Deletes function table.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>ftfree</command> ifno, iwhen</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
    <emphasis>ifno</emphasis> -- the number of the table to be deleted
    </para>
    <para>
    <emphasis>iwhen</emphasis> -- if zero the table is deleted at init
    time; otherwise the table number is registered for being deleted at
    note deactivation. 
    </para>

  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the ftfree opcode. It uses the file <ulink url="examples/ftfree.csd"><citetitle>ftfree.csd</citetitle></ulink>.
      <example>
        <title>Example of the ftfree 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/ftfree.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
      <screen>
instr 1:  gitempTable = 101.000
B  0.000 ..  3.000 T  3.000 TT  3.000 M:  0.50000  0.50000
INIT ERROR in instr 1: Invalid ftable no. 101.000000
instr 1:  gitempTable = 101.000
Error deleting ftable 101
	  B  3.000 - note deleted.  i1 had 1 init errors
B  3.000 ..  5.000 T  5.000 TT  5.000 M:  0.00000  0.00000
      </screen>
    </para>
  </refsect1>
  
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Authors: &namesteven;, &nameistvan;</member>
        <member>2005</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>