<Array>.SeekByProcedure (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Queue, stack, list and array functions / Array functions

WLanguage comparison procedure

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Array>.SeekByProcedure (Function)

In french: <Tableau>.ChercheParProcédure

Seeks an element in a one-dimensional WLanguage array by using a comparison procedure.

Example

// Create an array of references
arrReference is array of strings
// Find a reference identified by its first 6 characters
nIndex is int
nIndex = arrReference.SeekByProcedure(ProcCompareShortReference, ...
		asLinear, 0, "123456")

// ProcCompareShortReference procedure
INTERNAL PROCEDURE ProcCompareShortReference(SoughtElement, Search)
	// Compare the first 6 characters of the elements in the array 
	// with the sought reference
	RETURN StringCompare(Left(SoughtElement, 6), Search)
END

Syntax

<Result> = <WLanguage array>.SeekByProcedure(<WLanguage procedure> , <Type of search> [, <Start index> [, <Sought value 1> [... [, <Sought value N>]]]])

<Result>: Integer

Index of the element found in the array.

<WLanguage array>: Array

Name of the Array variable where the search will be performed. This array must be a one-dimensional array.

<WLanguage procedure>: Procedure name

WLanguage comparison procedure. For more details, see the remarks.

<Type of search>: Integer constant

Type of search to perform:
asBinary Descending binary search.
This search mode is fast but it must be used on an array sorted in ascending order with the same comparison procedure or with an equivalent procedure (see <Array>.Sort).
asBinaryCompliant Ascending binary search.
This search mode is fast but it must be used on an array sorted in ascending order with the same comparison procedure or with an equivalent procedure (see <Array>.Sort).
asLinear Linear search. The search starts:
from the first element if <Start index> is set to 0,
from <Start index>.
The search stops as soon as an element is found.
asLinearFirst Linear search from the first element. <Start index> is ignored when this constant is specified.
asLinearLast Linear search from the last element. This constant must not be used if <Start index> is specified.
asLinearNext Linear search for the next element. This search is performed from the current position (if <Start index> is set to 0) or from the position specified by <Start index>.
asLinearPrevious Linear search for the previous element. This search is performed from the current position or the value of <Start index>.

<Start index>: Optional integer

Start position for the search (linear search only). This parameter is not required for a binary search.

<Sought value 1>: Any type

Value of the search element.

<Sought value N>: Any type

Value of the search element.

Remarks

WLanguage comparison procedure

This comparison procedure has the following format:

PROCEDURE <Nom Procédure>(<Elément> , <Valeur recherchée 1> [, ... [<Valeur recherchée N>]])

This procedure is called as many times as necessary.

The first parameter of the procedure corresponds to the array element to compare.
The other parameters are the search values passed as parameter to <Array>.SeekByProcedure.

The comparison procedure must return the following values:

If the array element is too small in relation with the search values, the procedure must return -1.
If the array element is too large in relation with the search values, the procedure must return 1.
If the array element corresponds to the search values, the procedure must return 0.

Please note In the case of binary search, the comparison procedure must return the following values:

If the array element is too small in relation to the search values, the procedure must return 1.
If the array element is too large in relation to the search values, the procedure must return -1.
If the array element corresponds to the search values, the procedure must return 0.

Component: wd300vm.dll