UI_GET_KEY Function

Syntax

Key as P = ui_get_key([C title [,C prompt [,N type [,C expression_or_index_name [,C imagename ]]]]])

Arguments

Key: A dot variable with two properties. .value = return_value .type = variable type
title: Optional. Default = "Find by Key". The title of the dialog.
prompt: Optional. Default = "Search for". The prompt to the left of the text box.
type: Optional. Default = 1. 1 = Name will contain the name of an index 2 = based on current primary index
expression_or_index_name: Optional. Default = "". The name of an index if Type is 1. An order expression if Type is 2.
imagename: Optional. Default = "$a5_find_by_key".

Description

Find by key. Type 1 = index name, Type 2 = any expression.

Discussion

The UI_GET_KEY() function displays a dialog that prompts the user to select a key value from an index. You must run this function from a form layout.

Example

dim value as C
value = UI_GET_KEY("Last Name", "Select Last Name", 1,)
ui_msg_box("", value)

Limitations

Desktop applications only.