SftMask/DLL 7.0 - Masked Edit Control

AutoCompleteSeed

Adds an array of strings to the autocomplete save file, skipping entries already present.

C

BOOL SftMask_AutoComplete_Seed(HWND hwndCtl, LPCTSTR * lplpszEntries, int count);

C++

BOOL CSftMask::AutoCompleteSeed(LPCTSTR * lplpszEntries, int count);

Parameters

hwndCtl

The window handle of the masked edit control.

lplpszEntries

An array of strings to add.

count

The number of strings in the array.

Returns

The return value is TRUE if the entries were added and the save file was written successfully. FALSE is returned if no autocomplete save file is configured (auto_lpszFile field).

Comments

Entries already present in the save file are left unchanged, so seeding is cumulative and can safely be repeated at every application start - entries the user has entered are preserved. The auto_nMaxEntries limit is honored.

Seeding allows an application to offer meaningful suggestions the very first time the user encounters the control, instead of starting with an empty suggestion list. Configure the auto_lpszFile field (using SetControlInfo) before calling AutoCompleteSeed.

static LPCTSTR Names[] = { TEXT("Aaron"), TEXT("Alice"), TEXT("Andrew") };
SftMask_AutoComplete_Seed(hwndCtl, Names, 3);

See Also AutoComplete | AutoCompleteAddBottom | AutoCompleteRefresh