string<=

Type:	-	function (subr)
Source:	-	xlstr.c

Syntax

(string<= string1 string2 [key offset] ... )

stringN - a string expression
key - a keyword [one of :start1 :start2 :end1 :end2]
offset - an optional integer expression for a keyword
returns - a non-NIL value if string1 is less than or equal to string2 in ASCII ordering, NIL otherwise
Note: case is significant with this function

Description

The 'string<=' [string-less-than-or-equal] function takes two string arguments. A non-NIL value is returned if 'string1' is less than or equal to 'string2' in ASCII ordering, otherwise NIL is returned. The non-NIL value returned is the integer index of the first character of 'string1' which is char<= [char-less-than-or-equal] to the corresponding character of 'string2'. This test is case sensitive, the character '#\a' is different and of greater ASCII value than '#\A'.

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].

Examples

(string<= "a" "b")                ; returns 0
(string<= "a" "a")                ; returns 1
(string<= "a" "A")                ; returns NIL
(string<= "A" "a")                ; returns 0
(string<= "abc" "abc ")           ; returns 3
(string<= "1234567" "1234qrst")   ; returns 4

(string<= "J Smith" "K Smith" :start1 1 :start2 1)  ; strip off the first chars
                                                    ; returns 7

See the string<= function in the XLISP 2.0 manual.

  Back to Top