The Explorer_SQL_Search_Generic procedure is used to create a SQL results set that contains the key values for the records matching the specified search criteria. This procedure can be used if SmartList is running with SQL Server but you have chosen not to use the SmartList’s built-in SQL optimization.
|
We strongly recommend that you use SmartList’s built-in optimization when creating SmartList objects that are designed to work with SQL Server. |
Explorer_SQL_Search_Generic, Object_Dict_ID, Object_Type, Searching, Field_Dict_ID, Field, Datatype, Type, Search_From, Search_To, Match_Case, DDL_Type, Field_Comparison, Start_Comp_Field_ID, Start_Comp_Field_Dict_ID, End_Comp_Field_ID, End_Comp_Field_Dict_ID, Global_Search_Type, Search_Field_Name, Search_Field_Dict_ID, Search_Table_Name, SQL_Connection, Error, Get_Summary, Summary_Type, Summary_Count, Summary_Field_Dict_ID, Summary_Field_ID, Column_Total
• 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.
• 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.
• DDL_Type – An array of four integers indicating whether list fields used for the search are 0-based or 1-based. The value 0 indicates 0-based, while the value 1 indicates 1-based.
• 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.
• Global_Search_Type – An integer indicating the type of search: Match All or Match 1 or More.
• Search_Field_Name – An array of four strings containing the technical names of all of the search fields.
• Search_Field_Dict_ID – An array of four integers containing the dictionary IDs for the search fields.
• Search_Table_Name – An array of four strings containing the names of the tables for the search fields.
• SQL_Connection – A returned long integer that is the connect to the SQL results set containing the key values for the items returned by the search. Use functions such as SQL_FetchNext() and SQL_GetData() to retrieve the results.
• Error – A returned integer indicating whether the search could be completed. The value 0 indicates the search was completed. The value -1 indicates the search could not be completed, and a manual sequential search should be performed.
• Get_Summary – A boolean specifying whether summary information for a column is being retrieved.
• Summary_Type – An integer specifing the type of summary information to retrieve for a column. The value 0 indicates the number of records will be retrieved, while the value 1 indicates the total of the column will be retrieved.
• Summary_Count – A returned integer containing the number of records that match the search.
• Summary_Field_Dict_ID – An integer indicating the dictionary ID of the field that will be summarized.
• Summary_Field_ID – An integer indicating the resource ID of the field that will be summarized.
• Column_Total – A returned currency containing the total of the specified column for the records that match the search.