PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Special cases
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Seeks the index of an element in a WLanguage array. The following searches can be performed:
  • Seek an element in a one-dimensional array of simple elements.
  • Seek an element in a two-dimensional array of simple elements according to a column.
  • Seek an element in a two-dimensional array of simple elements according to several columns.
  • Seek an element in a one-dimensional array of structures or classes.
  • Seek an object in an array.
Remarks:
  • This function is equivalent to Seek.
Example
arrMyArray is array of 0 string
// Fill the array
ArrayAdd(arrMyArray, "WINDEV")
ArrayAdd(arrMyArray, "WEBDEV")
ArrayAdd(arrMyArray, "WINDEV and WEBDEV")
// Find "WINDEV"
ResIndex is int
ResIndex = ArraySeek(arrMyArray, asLinearFirst, "WINDEV")
Info("The WINDEV string is found at index: " + ResIndex)
// Returns: "The WINDEV string is found at index: 1"
Syntax

Seeking an element in a one-dimensional array of simple elements Hide the details

<Result> = ArraySeek(<WLanguage array> , <Type of search> , <Sought value> [, <Start index>])
<Result>: Integer
  • Index of the sought element,
  • -1 if the element is not found in the array.
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array.
This array can also correspond to a one-dimensional array associated with a property of advanced variable.
<Type of search>: Integer constant
Type of search to perform:
asBinaryBinary search.
This search mode is fast but it must be used on an array sorted in ascending order, without duplicates.
Search options (lexicographical order, ignore punctuation, etc.) must be exactly the same for the search (ArraySeek) and for the sort (ArraySort).
asLinearLinear search. The search starts:
  • from the first element.
  • from the value of the parameter <Start index>.
The search stops as soon as an element is found.
asLinearFirstLinear search from the first element. <Start index> is ignored when this constant is specified.
asLinearLastLinear search from the last element. This constant must not be used if <Start index> is specified.
asLinearNextLinear search for the next element. This search is performed from the current position or the value of <Start index>.
asLinearPreviousLinear search for the previous element. This search is performed from the current position or the value of <Start index>.

The type of search can be combined with one or more search options:
tccIgnoreAccentSearch ignoring accented characters.
This option can only be used on the arrays of character strings.
tccIgnoreCaseSearch ignoring the case.
This option can only be used on the arrays of character strings.
tccIgnoreInsideSpaceSearch ignoring spaces inside strings.
This option can only be used on the arrays of character strings.
tccIgnorePonctuationAndSpaceSearch ignoring spaces and punctuation.
This option can only be used on the arrays of character strings.
tccIgnoreSpaceSearch ignoring spaces at the beginning and end of strings.
This option can only be used on the arrays of character strings.
tccLexicographicOrderArray sorted according to the linguistic order.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option can only be used on the arrays of character strings.
tccRespectNumericArray sorted according to the order of numeric values.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option can only be used on the arrays of character strings.

AndroidAndroid Widget The constants used to define the search options are not available.
For a dichotomous search, the search options must be exactly the same as the options that were used to sort the array (see ArraySort).
<Sought value>: Any type
Value of element whose index is requested.
<Start index>: Optional integer
Start position for the search (linear search only). This parameter is not required for a binary search.

Searching for an element in a two-dimensional array of simple elements using a column Hide the details

<Result> = ArraySeek(<WLanguage array> , <Type of search> , <Column> , <Sought value> [, <Start index>])
<Result>: Integer
  • Index of the sought element,
  • -1 if the element is not found in the array.
<WLanguage array>: Array
Name of the Array variable to use. This array must be a two-dimensional array.
This array can also correspond to a two-dimensional array associated with a property of an advanced variable (for example sorting a variable of type xlsDocument according to the values of a column).
<Type of search>: Integer constant
Search to perform:
asBinaryBinary search.
This search mode is fast but it must be used on an array sorted in ascending order, without duplicates, and by using exactly the same search options as the ones used for the sort (ArraySort).
asLinearLinear search. The search starts:
  • from the first element.
  • from the value of the parameter <Start index>.
The search stops as soon as an element is found.
asLinearFirstLinear search from the first element. This constant must not be used if <Start index> is specified.
asLinearLastLinear search from the last element. This constant must not be used if <Start index> is specified.
asLinearNextLinear search for the next element. This search is performed from the current position or the value of <Start index>.
asLinearPreviousLinear search for the previous element. This search is performed from the current position or the value of <Start index>.

The type of search can be combined with one or more search options:
tccIgnoreAccentSearch ignoring accented characters.
This option can only be used on the arrays of character strings.
tccIgnoreCaseSearch ignoring the case.
This option can only be used on the arrays of character strings.
tccIgnoreInsideSpaceSearch ignoring spaces inside strings.
This option can only be used on the arrays of character strings.
tccIgnorePonctuationAndSpaceSearch ignoring spaces and punctuation.
This option can only be used on the arrays of character strings.
tccIgnoreSpaceSearch ignoring spaces at the beginning and end of strings.
This option can only be used on the arrays of character strings.
tccLexicographicOrderArray sorted according to the linguistic order.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option can only be used on the arrays of character strings.
tccRespectNumericArray sorted according to the order of numeric values.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option can only be used on the arrays of character strings.

AndroidAndroid Widget The constants used to define the search options are not available.
For a dichotomous search, the search options must be exactly the same as the options that were used to sort the array (see ArraySort).
<Column>: Integer or character string
  • Simple array: Index of the column where the search will be performed.
  • Advanced array: Property for which the search must be performed. You also have the ability to use chained properties ("Border.Color" for example).
<Sought value>: Any type
Value of element whose subscript or property is requested.
<Start index>: Optional integer
Start position for the search (linear search only). This parameter is not required for a binary search.

Searching for an element in a two-dimensional array of simple elements using multiple columns Hide the details

<Result> = ArraySeek(<WLanguage array> , <Type of search> , <Columns> , <Sought value 1> [, <Sought value 2> [... [, <Sought value N>]]] [, <Start index>])
<Result>: Integer
  • Index of the sought element,
  • -1 if the element is not found in the array.
<WLanguage array>: Array
Name of the Array variable to use. This array must be a two-dimensional array. This array can also correspond to a two-dimensional array of an advanced type (sort performed on a variable of type xlsDocument according to the values of one or more columns for example).
<Type of search>: Integer constant
Search to perform. No binary search is available.
asLinearLinear search. The search starts:
  • from the first element.
  • from the value of the parameter <Start index>.
The search stops as soon as an element is found.
asLinearFirstLinear search from the first element. This constant must not be used if <Start index> is specified.
asLinearLastLinear search from the last element. This constant must not be used if <Start index> is specified.
asLinearNextLinear search for the next element. This search is performed from the current position or the value of <Start index>.
asLinearPreviousLinear search for the previous element. This search is performed from the current position or the value of <Start index>.
The type of search can be combined with one or more search options:
tccIgnoreAccentSearch ignoring accented characters.
This option is applied to all columns on which the search is performed.
This option is useful for arrays of strings.
tccIgnoreCaseSearch ignoring the case.
This option is applied to all columns on which the search is performed.
This option is useful for the arrays of character strings.
tccIgnoreInsideSpaceSearch ignoring spaces inside strings.
This option is applied to all columns on which the search is performed.
This option is useful for the arrays of character strings.
tccIgnorePonctuationAndSpaceSearch ignoring spaces and punctuation.
This option is applied to all columns on which the search is performed.
This option is useful for arrays of strings.
tccIgnoreSpaceSearch ignoring spaces at the beginning and end of strings.
This option is applied to all columns on which the search is performed.
This option is useful for the arrays of character strings.
tccLexicographicOrderArray sorted according to the linguistic order.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option is applied to all columns on which the search is performed.
This option is useful for arrays of strings.
tccRespectNumericArray sorted according to the order of numeric values.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option is applied to all columns on which the search is performed.
This option is useful for arrays of strings.

AndroidAndroid Widget The constants used to define the search options are not available.
For a dichotomous search, the search options must be exactly the same as the options that were used to sort the array (see ArraySort).
<Columns>: Character string
  • Simple array: List of columns where the search must be performed. The different columns must be separated by a semicolon. Example: "2;3" to perform a search on the columns 2 and 3.
  • Advanced array: List of properties where the search must be performed. The properties must be separated by a semicolon.
<Sought value 1>: Any type
Value of the element whose index or property is requested. A value must be indicated for each column or property specified in <Columns>.
<Sought value 2>: Any optional type
Value of the element whose index or property is requested. A value must be indicated for each column or property specified in <Columns>.
<Sought value N>: Any optional type
Value of the element whose index or property is requested. A value must be indicated for each column or property specified in <Columns>.
<Start index>: Optional integer
Start position for the search (linear search only). This parameter is not required for a binary search.

Seek an element in a one-dimensional array of structures, classes, advanced types or records. Hide the details

<Result> = ArraySeek(<WLanguage array> , <Type of search> , <Sought members> [, <Sought value 1> [, <Sought value 2> [... [, <Sought value N>]]]] [, <Start index>])
<Result>: Integer
  • Index of the sought element,
  • -1 if the element is not found in the array.
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array. This array can be:
  • an array of classes,
  • an array of structures,
  • an array of advanced types,
<Type of search>: Integer constant
Type of search to perform:
asBinaryBinary search.
This search mode is fast but it must be used on an array sorted in ascending order, without duplicates, and by using exactly the same search options as the ones used for the sort (ArraySort).
This search mode can also be used when performing a search on a single member.
asLinearLinear search. The search starts:
  • from the first element.
  • from the value of the parameter <Start index>.
The search stops as soon as an element is found.
asLinearFirstLinear search from the first element. This constant must not be used if <Start index> is specified.
asLinearLastLinear search from the last element. This constant must not be used if <Start index> is specified.
asLinearNextLinear search for the next element. This search is performed from the current position or the value of <Start index>.
asLinearPreviousLinear search for the previous element. This search is performed from the current position or the value of <Start index>.

The type of search can be combined with one or more search options:
tccIgnoreAccentSearch ignoring accented characters.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccIgnoreCaseSearch ignoring the case.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccIgnoreInsideSpaceSearch ignoring spaces inside strings.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccIgnorePonctuationAndSpaceSearch ignoring spaces and punctuation.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccIgnoreSpaceSearch ignoring spaces at the beginning and end of strings.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccLexicographicOrderArray sorted according to the linguistic order.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.
tccRespectNumericArray sorted according to the order of numeric values.
This option is useful for a dichotomous search and it has no effect on a linear search.
This option is applied to all members on which the search is performed.
This option is useful for the "character string" members.

AndroidAndroid Widget The constants used to define the search options are not available.
For a dichotomous search, the search options must be exactly the same as the options that were used to sort the array (see ArraySort).
<Sought members>: Character string
  • Structures and classes: Name of sought members. If several members are sought, their names must be separated by a semicolon. You also have the ability to chain the sought members (by using "." or ":" between the members). In a class, you also have the ability to perform a search on the class properties.
  • Advanced types: Name of sought properties. If several properties are sought, their names must be separated by a semicolon. You also have the ability to chain the sought properties (by using "." or ":" between the properties). For example, "Border.Color".
  • Records: Name of sought items. If several items are sought, their names must be separated by a semicolon. You also have the ability to chain the sought items (by using "." or ":" between the properties).
<Sought value 1>: Any type
Value of element whose member or property is requested. A value must be indicated for each member specified in <Sought members>.
<Sought value 2>: Any optional type
Value of element whose member or property is requested. A value must be indicated for each member specified in <Sought members>.
<Sought value N>: Any optional type
Value of element whose member or property is requested. A value must be indicated for each member specified in <Sought members>.
<Start index>: Optional integer
Start position for the search (linear search only). This parameter is not required for a binary search.

Searching for the index of an object in a one-dimensional array (syntax for the data binding) Hide the details

<Result> = ArraySeek(<WLanguage array> , <Type of search> , <Sought object>)
<Result>: Integer
  • Index of the sought object,
  • -1 if the object is not found in the array.
<WLanguage array>: Array
Name of the Array variable to use. This array must be a one-dimensional array. This array can be an array of classes, dynamic classes, structures, dynamic structures, advanced types, dynamic advanced types.
<Type of search>: Integer constant
Type of search to perform:
asLinearLinear search.
<Sought object>: Any type
Instance of sought object.
Remarks

Special cases

  • This function cannot be used on the fixed arrays.
  • This function can be used on the arrays of advanced variables.
  • This function cannot be used on the array of "Dynamic objects". The type of the objects must be specified.
  • This function must be used on the arrays of objects with a defined type.
    • For example, no search can be performed in the following array:
      t is array of 2 objects dynamic
    • On the contrary, a search can be performed in the following array:
      t is array of 2 MyClass

      t is array of 2 MyClass dynamic
  • No search can be performed on an array of variants.
  • AndroidAndroid Widget If the type of the search is dichotomous and if the array is not sorted, no WLanguage error will be displayed but the result of the search will be undefined.
Component: wd280vm.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Se existe janela aberta, não abra e se sair, limpe o array
//Global
arrayJanelas is array of string
----
//Se existe janela aberta não abra
ResSubscript is int = ArraySeek(arrayJanelas, asLinearFirst, NomeWindow)

IF ResSubscript = -1
Add(arrayJanelas, NomeWindow)
open(NomeWindow)
END

---

//Ao sair limpe do array a janela aberta em close window

nJanela is int = ArraySeek(arrayJanelas, asLinearFirst, MyWindow..name)

if nJanela > 0
arraydelete(arrayJanelas,nJanela)
end

BOLLER
11 Sep. 2019