Welcome to jBASE's new documentation site! Many answers to your questions can be found by searching the Knowledgebase or viewing the jBASE Documentation. We also have a Google Group for peer discussion about jBASE. If you are unable to find the information you are looking for, jBASE Support will be glad to assist in resolving your technical problems. Enjoy and please provide comments and feedback .

How can we help you?



The LOCATE statement finds the position of an element within a specified dimension of a dynamic array. It takes the general form: 

LOCATE expression1 IN expression2{<expression3{,expression4}>} {, expression5} {BY expression6} SETTING Var THEN|ELSE statements
LOCATE(expression1, expression2{,expression3{,expression4{,expression5}}}; Var{; expression6}) THEN|ELSE statements
LOCATE(expression1, expression2{,expression3{,expression5}}; Var{; expression6}) THEN|ELSE statements   (Prime*** syntax)


  • expression1 evaluates the string that will be searched for in expression2.
  • expression2 evaluates to the dynamic array on which an attribute search is performed within which expression1 will be searched for.
  • If expression3 is specified then a multivalue search is performed on expression2.
  • If both expression3 and expression4 are specified then a subvalue search is performed on expression2.
  • expression5 indicates the field number, value number or subvalue number from which the search will begin.
  • BY expression6 causes the search to expect the elements to be arranged in a specific order, which can considerably improve the performance of some searches. The available string values for expression6 are:
Values are in ascending left justified order
Values are in ascending right justified order
Values are in ascending numeric order
Values are in descending left justified order
Values are in right descending right justified order
Values are in descending numeric order
  • Var will be set to the position of the Field, MultiValue or SubValue in which expression1 was found. If it was not found and expression6 was not specified then Var will be set to one position past the end of the searched dimension. If expression6 specified the order of the elements then Var will be set to the position before which the element should be inserted to retain the specified order.
  • The statement must include one of or both of the THEN and ELSE clauses. If expression1 is found in an element of the dynamic array, it executes the statements defined by the THEN clause. If expression1 is not found in an element of the dynamic array, it executes the statements defined by the ELSE clause.


When the LOCATE statement is used in International Mode, the statement will use the currently configured locale to determine the rules by which each string is considered less than or greater than the other will.

An example of use may be as:

Name = "Nelson"
    INS Name BEFORE ForeNames<Pos>

The following example builds a multi-value list of Fibonacci numbers within the first 1,000,000 positive integers and then prompts the user to see if the numbers entered are in the list. This example uses expression3 in the LOCATE statement.

001     fib = ""
002     a = 0
003     b = 1
004     LOOP WHILE b < 1000000 DO
005         fib<1,-1> = b
006         c = b
007         b = a + b
008         a = c
009     REPEAT
011     LOOP
012         CRT "Enter number":
013         INPUT n
014     WHILE NUM(n) AND n NE "" DO
015         CRT n:
016         LOCATE n IN fib<1> BY "AN" SETTING pos THEN
017             CRT " is a fibonacci number at position ":pos:"."
018         END ELSE
019             CRT " is NOT a fibonacci number."
020         END
021     REPEAT


When dealing with sorted numeric data that are to be considered as non-numeric (e.g. part numbers), use the "AL" or "DL" sort specification.

When dealing with sorted numeric data, always use the "AN" or "DN" sort specification, especially when locating values that are decimal numbers.

When using the function-style syntax, zeros must be used as placeholders in order to use the expression5.

*** The Prime syntax can be obtained in any emulation by setting the generic_prime configuration option in the Config_EMULATE file under the appropriate emulation section as defined by the JBCEMULATE environment variable, e.g. generic_prime = true. Note that there is no sub-value search when using the Prime syntax.


Go back to jBASE BASIC

Was this article helpful?