summaryrefslogtreecommitdiff
path: root/docsrc/xlisp/xlisp-doc/reference/string-not-greaterp-s.htm
blob: 8710fdf6bf00421907fbc1b3b36a3473738f9b28 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<html><head><title>XLISP string&lt;=</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>string&lt;=</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>xlstr.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<dl>
<dt>(string&lt;= <i>string1 string2</i> [<i>key offset</i>] ... )</dt>
<dd><i>stringN</i> - a string expression<br>
<i>key</i> - a keyword [one of :start1 :start2 :end1 :end2]<br>
<i>offset</i> - an optional integer expression for a keyword<br>
returns - a non-<a href="nil.htm">NIL</a> value if <i>string1</i>
is less than or equal to <i>string2</i> in
<a href="../misc/ascii-table.htm">ASCII</a> ordering,
<a href="nil.htm">NIL</a> otherwise<br>
<b>Note:</b> case is significant with this function</dd>
</dl>

<h2>Description</h2>

<p>The 'string&lt;=' [string-less-than-or-equal] function takes two string
arguments. A non-<a href="nil.htm">NIL</a> value is returned if
'string1' is less than or equal to 'string2' in
<a href="../misc/ascii-table.htm">ASCII</a> ordering, otherwise
<a href="nil.htm">NIL</a> is returned. The
non-<a href="nil.htm">NIL</a> value returned is the integer index
of the first character of 'string1' which is
<a href="char-not-greaterp-s.htm">char&lt;=</a> [char-less-than-or-equal] to the
corresponding character of 'string2'. This test is case sensitive, the
character '#\a' is different and of greater
<a href="../misc/ascii-table.htm">ASCII</a> value than '#\A'.</p>

<p>The keyword arguments allow for accessing substrings within 'string1' and
'string2'. The keyword arguments each require a keyword ':start1', ':end1',
':start2' or ':end2' and a single integer expression as a pair with the
keyword first and the integer second. The pairs may be in any order. The
':startN' keywords specify the starting offset of the substring. A value of
0 starts the string at the beginning [no offset]. The ':endN' keywords
specify the ending offset of the substring. A value of 3 ends the string
after the 3rd character [an offset of 3 characters].</p>

<h2>Examples</h2>

<pre class="example">
(string&lt;= "a" "b")                <font color="#008844">; returns 0</font>
(string&lt;= "a" "a")                <font color="#008844">; returns 1</font>
(string&lt;= "a" "A")                <font color="#008844">; returns NIL</font>
(string&lt;= "A" "a")                <font color="#008844">; returns 0</font>
(string&lt;= "abc" "abc ")           <font color="#008844">; returns 3</font>
(string&lt;= "1234567" "1234qrst")   <font color="#008844">; returns 4</font>

(string&lt;= "J Smith" "K Smith" :start1 1 :start2 1)  <font color="#008844">; strip off the first chars</font>
                                                    <font color="#008844">; returns 7</font>
</pre>

<p>See the
<a href="../manual/xlisp-man-025.htm#string-less-than-or-equal">string&lt;=</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>