opcodes/ftloadk.xml


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

<refentry id="ftloadk">
<indexterm id="IndexFtloadk"><primary>ftloadk</primary></indexterm>
  <refentryinfo><title>Table Control:Read/Write Opreations</title></refentryinfo>
  <refmeta>
    <refentrytitle>ftloadk</refentrytitle>
  </refmeta>


  <refnamediv>
    <refname>ftloadk</refname>
    <refpurpose>
      Load a set of previously-allocated tables from a file.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Load a set of previously-allocated tables from a file.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>ftloadk</command> &quot;filename&quot;, ktrig, iflag, ifn1 [, ifn2] [...]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>&quot;filename&quot;</emphasis> -- A quoted string containing the name of the file to load.
    </para>

    <para>
      <emphasis>iflag</emphasis> -- Type of the file to load/save. (0 = binary file, Non-zero = text file)
    </para>

    <para>
      <emphasis>ifn1, ifn2, ...</emphasis> -- Numbers of tables to load.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ktrig</emphasis> -- The trigger signal. Load the file each time it is non-zero.
    </para>

    <para>
      <emphasis>ftloadk</emphasis> loads a list of tables from a file. (The tables have to be already allocated though.) The file's format can be binary or text. Unlike <link linkend="ftload"><citetitle>ftload</citetitle></link>, the loading operation can be repeated numerous times within the same note by using a trigger signal. 
    </para>

    <warning>
      <title>Warning</title>
      <para>
        The file's format is not compatible with a WAV-file and is not endian-safe. 
      </para>
    </warning>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="ftload"><citetitle>ftload</citetitle></link>,
      <link linkend="ftsavek"><citetitle>ftsavek</citetitle></link>,
      <link linkend="ftsave"><citetitle>ftsave</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 4.21</para>
  </refsect1>
</refentry>