reference/functions/nksp_sort_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>sort() function</title>
    <meta name="description" content="Sort the given array.">
  </head>
  <body>
    <h1>sort()</h1>
    <p>
      Sorts the values in the given array.
    </p>

    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
sort(??array??, [??descending??])
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??array??</code></td>
        <td>Integer Array Variable</td>
        <td>The integer array variable to be sorted.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??descending??</code></td>
        <td>Integer Number</td>
        <td>Defines in which order the array shall be sorted.<br>
            <b>0</b>: The values are sorted in ascending order.<br>
            <b>1</b>: The values are sorted in descending order.<br>
            [optional, default: <b>0</b>]</td>
      </tr>
    </table>

    <h3>Return Value</h3>
    <p>None.</p>

    <h3>Examples</h3>
    <p>None yet.</p>

    <h3>See also</h3>
    <p><code>search()</code>, <code>array_equal()</code><p>

    <h3>Availability</h3>
    <p>Since LinuxSampler 2.0.0.svn52.<p>

    <note>
      Dynamic, optional arguments are only supported by NKSP. If you want to
      retain compatibility to KSP, then you should always pass a parameter
      for the 2nd argument of this function.
    </note>
    
  </body>
</html>
1	schoenebeck	3223	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>sort() function</title>
5			<meta name="description" content="Sort the given array.">
6			</head>
7			<body>
8			<h1>sort()</h1>
9			<p>
10			Sorts the values in the given array.
11			</p>
12
13			<h3>Function Prototype</h3>
14			<p/>
15			<code lang="nksp">
16			sort(??array??, [??descending??])
17			</code>
18
19			<h3>Arguments</h3>
20			<table>
21			<tr>
22			<th>Argument Name</th> <th>Data Type</th> <th>Description</th>
23			</tr>
24			<tr>
25			<td><code>??array??</code></td>
26			<td>Integer Array Variable</td>
27			<td>The integer array variable to be sorted.<br>
28			[required]</td>
29			</tr>
30			<tr>
31			<td><code>??descending??</code></td>
32			<td>Integer Number</td>
33			<td>Defines in which order the array shall be sorted.<br>
34			<b>0</b>: The values are sorted in ascending order.<br>
35			<b>1</b>: The values are sorted in descending order.<br>
36			[optional, default: <b>0</b>]</td>
37			</tr>
38			</table>
39
40			<h3>Return Value</h3>
41			<p>None.</p>
42
43			<h3>Examples</h3>
44			<p>None yet.</p>
45
46			<h3>See also</h3>
47			<p><code>search()</code>, <code>array_equal()</code><p>
48
49			<h3>Availability</h3>
50			<p>Since LinuxSampler 2.0.0.svn52.<p>
51
52			<note>
53			Dynamic, optional arguments are only supported by NKSP. If you want to
54			retain compatibility to KSP, then you should always pass a parameter
55			for the 2nd argument of this function.
56			</note>
57
58			</body>
59			</html>