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