ClearSearchEdit function

Syntax

ClearSearchEdit([recordname.]fieldname)

Description

Use the ClearSearchEdit function to reverse the effects of a previous call to the SetSearchEdit function. If ClearSearchEdit is called for a specific field, the edits specified in the record field properties will not be applied to the field when it occurs in a search dialog.

Note:

This function remains for backward compatibility only. Use the SearchEdit Field class property instead.

Parameters

Parameter	Description
[recordname .]fieldname	The name of the target field, which is a search key or alternate search key about to appear in a search dialog box. The recordname prefix is not required if the program that calls ClearSearchEdit is on the recordname record definition.

Returns

Optionally returns a Boolean value indicating whether the function succeeded.