ClearSearchDefault function
Syntax
ClearSearchDefault([recordname.]fieldname)Description
Use the ClearSearchDefault function to disable default processing for the specified field, reversing the effects of a previous call to the SetSearchDefault function.
Note:
This function remains for backward compatibility only. Use the SearchDefault Field class property instead.
If search default processing is cleared for a record field, the default value specified in the record field properties for that field will not be assigned when the field appears in a search dialog box. This function is effective only when used in SearchInit PeopleCode.
Parameters
| Parameter | Description |
|---|---|
|
[recordname .]fieldname |
The name of the target field, which is a search key or alternate search key that is about to appear in a search dialog box. You must supply the recordname only if the record field and your PeopleCode program are in different locations. |
Returns
Optionally returns a Boolean value indicating whether the function succeeded.
Related Topics