PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • WLanguage comparison procedure
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 an element in a one-dimensional array by using a comparison procedure.
Remark: This function is equivalent to ArraySeekByProcedure.
Example
// Create an array of references
arrReference is array of strings
 
// Find a reference identified by its first 6 characters
nIndex is int
nIndex = SeekByProcedure(arrReference, ProcCompareShortReference, ...
asLinear, 0, "123456")
 
// ProcCompareShortReference procedure
INTERNAL PROCÉDURE ProcCompareShortReference(Element1, Search)
// Compare the first 6 characters of the array elements
// with the sought reference
RETURN StringCompare(Left(Element1, 6), Search)
END
Syntax
<Result> = SeekByProcedure(<WLanguage array> , <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 remarks.
<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 with the same comparison procedure or with an equivalent procedure (see ArraySort).
asLinearLinear search. The search starts:
  • from the first element if <Start index> is set to 0,
  • 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 (if <Start index> is set to 0) or from the position specified by <Start index>.
asLinearPreviousLinear search for the previous element. This search is performed from the current position or from the position specified by <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 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 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.
Caution: for the dichotomous 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: wd270vm.dll
Minimum version required
  • Version 17
This page is also available for…
Comments
Click [Add] to post a comment