Xbasic

UI_GET_FILTER Function

Syntax

Expression as C = ui_get_filter([C title [,C prompt [,C default [,C table_set_name ]]]])

Arguments

Expression: A character filter expression that evaluates to a logical value and selects records from the table or set.
title: Optional. Default = "". The title of the dialog box.
prompt: Optional. Default = "". The prompt inside the dialog box.
default: Optional. Default = "". The default value to display for the filter expression.
table_set_name: Optional. Default = current table or set. The table to use to evaluate the filter expression. Table_Set_Name may be a CR-LF delimited list of tables.

Description

Prompts for a filter expression. If table_set_name is not specified, current table/set is used. Table_set_name can be a crlf delimited list of tables.

Discussion

The UI_GET_FILTER() function prompts for a filter expression. If the Table_Set_Name is not provided, it uses the current table or set. Clicking on the icon displays the Expression Builder dialog box.

Example

dim prmpt_title as C
dim prmpt_prompt as C
dim prmpt_default as C
dim prmpt_tables as C
dim shared cFilter as C
prmpt_title = "Enter a Filter Expression"
prmpt_prompt = "Enter a filter expression that evaluates to a character value"
prmpt_default = ""
prmpt_tables = "customer"
cFilter = ui_get_filter(prmpt_title,prmpt_prompt,prmpt_default,prmpt_tables)

Limitations

Desktop applications only.