$Lstr_Word
Return a word from a long string
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $Lstr_Word is Word (except that Word does not allow a word number argument less than 1, as does $Lstr_Word.) Or, you may find the features of the StringTokenizer to be more helpful.
This function takes a longstring input and a word number and returns a longstring containing a single word. A null string is returned if the word count in the input longstring is less than the word number.
The $Lstr_Word function accepts three arguments and returns a longstring result.
The first argument is an arbitrary longstring. This is a required argument.
The second argument is the number of the desired word. The first word in the input longstring is word 1.
The third argument is a string containing from 1 to 255 characters which are the delimiters for the longstring. This is an optional argument and defaults to a blank.
Syntax
%result = $Lstr_Word(longstring, n, delims)
%result is the nth word in the longstring.
Usage notes
- Prior to Sirmods Version 7.3 (or Version 7.1 or 7.2, with maintenance applied), if the result of $Lstr_Word was longer than 255 bytes, either the request was cancelled or the result was truncated at 255 bytes.
Examples
- To set %RES to "shore":
%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7)
- To set %RES to "sea":
%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7, '- ')
See also
- Word - Select word from list of words
- Words - Sublist of list of words
- WordCount - Count words in list
- WordNumberIn and WordNumberOf - Word number of "needle" word within "haystack" list of words
Products authorizing $Lstr_Word
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- [[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]