$Lstr Word: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Return a word from a long string<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Return a word from a long string<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Lstr_Word function, but the functionality is available in the [[StringTokenizer class]].</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Lstr_Word</var> is <var>[[Word (String function)|Word]]</var> (<b>except</b> that <var>Word</var> does not allow a word number argument less than 1, as does <var>$Lstr_Word</var>.) Or, you may find the features of the [[StringTokenizer class|StringTokenizer]] to be more helpful.</p>


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.  
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.  
Line 33: Line 33:


$Lstr_Word is only available in ''[[Sirius Mods]]'' Version 6.5 and later. Prior to 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.
$Lstr_Word is only available in ''[[Sirius Mods]]'' Version 6.5 and later. Prior to 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.
==See also==
<ul>
<li><var>[[Word (String function)|Word]]</var> - Select word from list of words
<li><var>[[Words (String function)|Words]]</var> - Sublist of list of words
<li><var>[[WordCount (String function)|WordCount]]</var> - Count words in list
<li><var>[[WordNumberIn and WordNumberOf (String functions)|WordNumberIn and WordNumberOf]]</var> - Word number of "needle" word within "haystack" list of words
</ul>


<p>
<p>

Revision as of 19:43, 27 April 2011

<section begin="desc" />Return a word from a long string<section end="desc" />

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

<section begin="syntax" /> %RESULT = $Lstr_Word(longstring, n, delims) <section end="syntax" />

$Lstr_Word function

%RESULT is the nth word in the longstring.

For example

%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7)

sets %RES to "shore" and

%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7, '- ')

sets %RES to "sea".

$Lstr_Word is only available in Sirius Mods Version 6.5 and later. Prior to 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.

See also

Products authorizing $Lstr_Word

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Word&oldid=35382"