TableSeek (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

See also

TableSeek (Function)

In french: TableCherche

Performs a search in:

a Table control,
a TreeView Table control,
a table displayed in a Combo Box control.

Two search modes are available:

Search for an element in a column.
Search for an element in the stored value of control.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Versions 19 and later

This function is now available in Browser code for Table controls in browser mode.

New in version 19

This function is now available in Browser code for Table controls in browser mode.

Versions 20 and later

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

New in version 20

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

This function is now available for Android applications.

This function is now available for iPhone/iPad applications.

Example

// Finds the "Shirt" element in the "COL_Product" column
// Generic search performed from row 5
ResSearch = TableSeek(COL_Product, "Shirt", False, 5)

// Used to list all occurrences of a sought value.
Result1 is int
Result1 = TableSeek(COL_ColumnName, "SoughtValue", True)
WHILE Result1 <> -1
Trace(Result1)
Result1 = TableSeek(COL_ColumnName, "SoughtValue", ...
True, Result1 + 1)
END

// Finds the "Shirt" element in the "COL_Product" column
// Generic search performed from row 5
let ResSearch = TableSeek(COL_Product, "Shirt", searchStartsWith, 5)

// Used to list all occurrences of a sought value.
Result1 is int
Result1 = TableSeek(COL_ColumnName, "SoughtValue", searchExactMatch)
WHILE Result1 <> -1
Trace(Result1)
Result1 = TableSeek(COL_ColumnName, "SoughtValue", ...
searchExactMatch, Result1 + 1)
END

Syntax

Seeking an element in a column Hide the details

<Result> = TableSeek(<Column name> , <Sought element> [, <Type of search> [, <Source row>]])

<Result>: Integer

Subscript of element found,
-1 if no element corresponds to the search.
If the search is performed:
in a memory Table control, the element found is not selected. To select the element found, use TableSelectPlus.
in a browsing Table control, the element found is not selected, the rows found in the Table control scroll until the sought element is reached.

<Column name>: Character string (with or without quotes)

Name of column where the search is performed.
If this parameter corresponds to an empty string (""), the column to which the current process belongs will be used.
In a browsing Table or TreeView Table control, the search column must be linked to a key item. No search can be performed on a column that is not linked to an item.

<Sought element>: Type of sought element

Element that must be found in the specified column. If the type of the sought element is:
"Date" or "Time": the search is performed on the returned value.
"Currency + Euro": the search is performed on the stored currency.

<Type of search>: Optional Integer constant

Type of search to perform:
True (default value): Exact-match search ("Equals to"): The elements whose value is strictly equal to <Sought element> are returned.
False: Generic search ("Starts with"): The elements whose value starts with <Sought element> are returned.
Type of search to perform:
Versions 21 and later
searchStartsWith
New in version 21
searchStartsWith
searchStartsWith (or False for compatibility) Generic search whose type is "Starts with"
The elements whose value starts with <Sought element> are returned.
Versions 21 and later
searchContains
New in version 21
searchContains
searchContains Generic search whose type is "Contains"
The elements whose value contains <Sought element> are returned.
This constant is not available.
Versions 21 and later
searchDefault
New in version 21
searchDefault
searchDefault Default search. for this function, the default search is an exact-match search (whose type is "Equals to").
The elements whose value is strictly equal to <Sought element> are returned.
This constant is not available.
Versions 21 and later
searchExactMatch
New in version 21
searchExactMatch
searchExactMatch (or True for compatibility)
(Default value) Exact-match search ("Equals to")
The elements whose value is strictly equal to <Sought element> are returned.

<Source row>: Optional integer

Number of the source row for the search.
If this parameter is not specified, the search is performed in the entire column.
This parameter is used to find all the occurrences of a string in a column.
This parameter is ignored for a browsing Table control.

Seeking an element in a Table control (stored value) Hide the details

<Result> = TableSeek(<Table control> , <Sought value>)

<Result>: Integer

Subscript of element found,
-1 if no element corresponds to the search.

<Table control>: Control name

Name of control to use. This control can correspond to:
a Table control.
a TreeView Table control.
a Combo Box control with table.
The Table control must be linked to a data file or to a variable.

<Sought value>: Type of sought element

Value of sought element. This value is sought in the stored value of control.

Remarks

Use conditions

Syntax 1: Seeking an element in a column is available for:

a Table or TreeView Table control,
a browsing or memory control,
a table displayed in a Combo Box control,
Versions 19 and later
a Table control in browser mode,
New in version 19
a Table control in browser mode,
a Table control in browser mode,
a single-selection or multiselection control.
Reminder: Multiselection controls are available in Ajax only Reminder: Multiselection is not available on "classic" Table controls.

For a browsing Table or TreeView Table control:

the browse mode must be automatic.
the column must be linked to a key item.

Syntax 2: Seeking an element in the stored value is available for:

a Table or TreeView Table control.
a browsing control or a control linked to a variable.
a single-selection or multiselection control.
Reminder: Multiselection controls are available in Ajax only Reminder: Multiselection is not available on "classic" Table controls.

Type of search

Exact-match search: The elements whose value is strictly equal to <Sought element> are returned by TableSeek. For example:

// Return all customers whose name is "Smith" from "COL_NameColumn"
TableSeek(COL_NameColumn, "Smith")
Generic search: The elements starting with <Sought element> are returned by TableSeek.
For example:

// Return all customers whose name starts with "SMI"
TableSeek(COL_NameColumn, "SMI", False)

For example:

// Return all customers whose name starts with "SMI"
TableSeek(COL_NameColumn, "SMI", searchStartsWith)

Browsing table

In a browsing table, the following syntax can be used to seek an element in a column:

TableName = SoughtElement
On the browsing tables with direct access, when using TableSeek:
- the display of the Table control is moved.
- the returned subscript corresponds to an "approximate" subscript because this type of Table control can manage billions of records.

Various

In a memory Table control, the search performed by TableSeek is not case sensitive (uppercase/lowercase characters).
In a browsing Table control, the search performed by TableSeek takes into account the search characteristics defined in the analysis for the item linked to the search column (case sensitivity, etc.).

Component : wd240obj.dll