/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_search_function.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_search_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3224 - (show annotations) (download) (as text)
Fri May 26 19:47:44 2017 UTC (3 years, 6 months ago) by schoenebeck
File MIME type: text/html
File size: 1664 byte(s)
- Fixed minor typo.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>search() function</title>
5 <meta name="description" content="Search for a certain value within an array.">
6 </head>
7 <body>
8 <h1>search()</h1>
9 <p>
10 Searches for the sought value <code>??needle??</code> in the given
11 <code>??array??</code>, if such a value is found, then this function
12 returns the first index of the value being found. Otherwise if the
13 array does not have such a value, it returns <code>-1</code> instead.
14 </p>
15
16 <h3>Function Prototype</h3>
17 <p/>
18 <code lang="nksp">
19 search(??array??, ??needle??)
20 </code>
21
22 <h3>Arguments</h3>
23 <table>
24 <tr>
25 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
26 </tr>
27 <tr>
28 <td><code>??array??</code></td>
29 <td>Integer Array Variable</td>
30 <td>The integer array variable to be scanned.<br>
31 [required]</td>
32 </tr>
33 <tr>
34 <td><code>??needle??</code></td>
35 <td>Integer Number</td>
36 <td>The value to be searched for.<br>
37 [required]</td>
38 </tr>
39 </table>
40
41 <h3>Return Value</h3>
42 <table>
43 <tr>
44 <th>Description</th> <th>Data Type</th>
45 </tr>
46 <tr>
47 <td>Index of the first element found with that value, otherwise <code>-1</code> if nothing found.</td>
48 <td>Integer Number</td>
49 </tr>
50 </table>
51
52 <h3>Examples</h3>
53 <p>None yet.</p>
54
55 <h3>See also</h3>
56 <p><code>sort()</code>, <code>array_equal()</code><p>
57
58 <h3>Availability</h3>
59 <p>Since LinuxSampler 2.0.0.svn52.<p>
60
61 </body>
62 </html>

  ViewVC Help
Powered by ViewVC