View source for $ListLoc

{{DISPLAYTITLE:$ListLoc}}
<span class="pageSubtitle">Locate string in $list</span>

<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $ListLoc is <var>[[Locate and LocateUp (Stringlist functions)|Locate]]</var> (although, as noted [[#Different order of Locate arguments|below]], the order of the search string and start item arguments has changed).</p>

This function locates a specified string in a $list. 

The <var>$ListLoc</var> function accepts six arguments and returns the item number of the $list item containing the string or an error code. 

The first argument is the identifier of the $list in which a string is to be located. This is a required argument. 

The second argument is a number that indicates the item number at which the search is to begin. If this argument is not specified searching begins at the first item in the $list. 

The third argument is the string to be located. If this argument is not specified, all $list items are considered to contain the search string. 

The fourth argument is either a number that specifies the starting column of a range of columns in which the search string must be located or a string containing the name of an image item in the image associated with the $list using [[$ListImg]]. In the latter case, the start column for the search is the position of the image item in the image. This is an optional argument and defaults to 1. 

The fifth argument is a number that specifies the ending column of a range of columns in which the search string must be located. This is an optional argument and defaults to one of the following values:

<ul>
<li>if the fourth argument specifies an image item name, the position of the end of the image item in the image 
<li>otherwise, 6124 
</ul>

The sixth argument is an indicator for case-insensitive comparisons. If this argument is a non-zero integer, the string comparisons use $list item data translated to uppercase (hence your search string should be passed as an uppercase value). This is an optional argument and defaults to 0. If the sixth argument is non-zero, then the width of the column range is reduced to a maximum of 256.

The seventh argument, available only in <var class="product">Sirius Mods</var> 8.1 and later, is an indicator for arbitrary blank matching. If this argument is a non-zero integer, single (') and double (") quotes are treated as matches for each other. This can be useful when searching through procedures that contain code where single and double quotes can be used interchangeably to enclose string literals. Such code includes User Language, Javascript, and XML (including XSLT). This is an optional argument and defaults to 0. If the seventh argument is non-zero, then the width of the column range is reduced to a maximum of 256.

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListLoc</span>(<span class="term">list_identifier</span>, [<span class="term">start</span>], [<span class="term">search_string</span>] -
                    [<span class="term">start_col</span>], [<span class="term">end_col</span>], [<span class="term">case_ignore</span>], [<span class="term">arb_quote</span>])
</p>
<p>
</p>
<p><var class="term">%result</var> is set either to the item number of the first item in the $list that matches the search criteria, or to a negative number if an error has occurred.</p>

===Error codes===
<p class="code">-5 - Required argument not specified
-6 - $List identifier invalid
-7 - Item number not found in $list
-8 - String not found (if $list empty, -7)
-9 - Invalid column range
</p>

==Examples==
<ol>
<li>The following code locates a string in columns 31 through 39 of a $list.

<p class="code">%NUM = $ListLoc(%LIST, , 'EUDAEMONIC', 31, 39)
</p>

<li>In the following code, an image is associated with the $list, items are added to the $list from the image and then the $list is searched for an item that contains a particular value in the columns associated with a specific image item.

<p class="code">IMAGE CUST
LNAME IS STRING LEN 30
FNAME IS STRING LEN 30
ID IS STRING LEN 9
END IMAGE
 
PREPARE IMAGE CUST
 
%LIST = $ListNew
%RC = $ListImg(%LIST, %CUST:LAME)
 
 . . . 
 
FOR EACH RECORD IN LCUST
 . . . 
%RC = $ListAddI(%LIST)
 . . . 
END FOR
 
 . . . 
 
%ITEMNUM = $ListLoc(%LIST, , %LOCID, 'ID')
</p>

Note that this use of an image item name simply sets the range of columns for a match. If an entry with an exact match for the image item is required, <var>[[$ListFindI and $ListFindI_Up|$ListFindI]]</var> should be used.
</ol>

==Different order of Locate arguments==
As metioned above, the OO equivalent for <var>$ListLoc</var> is <var>[[Locate and LocateUp (Stringlist functions)|Locate]]</var>.  However, the order of the search string and start item arguments for <var>Locate</var> and <var>$ListLoc</var> is reversed. The following two lines of code are equivalent, assuming that the $list represented by <code>%list</code> and the <var>Stringlist</var> <code>%strLis</code> are equivalent:
<p class="code">%it = $listLoc(%list, %startNum, 'find this string')
%it = %strLis:locate('find this string', %startNum)
</p>

==Products authorizing {{PAGENAMEE}}== 
<ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>Japanese functions</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>

</ul>
 
<p>
</p>

[[Category:$Functions|$ListLoc]]