Explorer_Search_Generic

Examples


The Explorer_Search_Generic procedure is called to determine whether the current record meets the search criteria specified by the SmartList user. The return value true indicates the record should be displayed in the SmartList.

Syntax

Explorer_Search_Generic, Object_Dict_ID, Object_Type, Searching, Field_Dict_ID, Field, Datatype, Type, Search_From, Search_To, Match_Case, Global_Search_Type, Field_Comparison, Start_Comp_Field_ID, Start_Comp_Field_Dict_ID, End_Comp_Field_ID, End_Comp_Field_Dict_ID, Found

Parameters

Object_Dict_ID – An integer specifying the dictionary that has defined the SmartList object.

Object_Type – An integer indicating the SmartList object in the specified dictionary that is being used to display records. For SmartList objects defined in the core application, use one of the constants described in SmartList objects.

Searching – An array of four boolean values indicating whether any search criteria are being used. If no search criteria are used, the Found parameter will always return true.

Field_Dict_ID – An array of four integers containing the dictionary IDs of the fields being searched.

Field – An array of four integers containing the resource IDs of the fields being searched.

Datatype – An array of four integers containing the datatypes of the fields being searched.

Type – An array of four integers that indicate the type of searches being performed. For instance, “contains” or “is equal to” are common search types.

Search_From – An array of four strings that the search fields will be compared to.

Search_To – An array of four strings that the search fields will be compared to.

Match_Case – An array of four booleans indicating whether the search should match case.

Global_Search_Type – An integer indicating the type of search: Match All or Match 1 or More.

Field_Comparison – An array of four booleans indicating that the search to be performed is comparing the contents of two fields in the SmartList.

Start_Comp_Field_ID – An array of four integers containing the resource IDs of the fields that will be compared.

Start_Comp_Field_Dict_ID – An array of four integers containing the dictionary IDs for the fields that will be compared.

End_Comp_Field_ID – An array of four integers containing the resource IDs of the fields that will be compared.

End_Comp_Field_Dict_ID – An array of four integers containing the dictionary IDs for the fields that will be compared.

Found – A returned boolean indicating whether the record matches the search criteria.

Comments

This procedure is used for SmartList objects that are not optimized for SQL Server. Most of the parameters passedto this procedure originate from the SmartList.


Documentation Feedback