SftTree/DLL 7.5 - Tree Control

FindStringEx

Searches cells for a string.

C

int WINAPI SftTree_FindStringEx(HWND hwndCtl, int index, int endIndex, 
        int realCol, int level, LPCTSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);
int WINAPI SftTree_FindStringEx_W(HWND hwndCtl, int index, int endIndex,
        int realCol, int level, LPCWSTR lpszText, BOOL fWrap, BOOL fIgnoreCase,
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);
int WINAPI SftTree_FindStringEx_A(HWND hwndCtl, int index, int endIndex, 
        int realCol, int level, LPCSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);
int WINAPI SftTreeSplit_FindStringEx(HWND hwndCtl, int index, int endIndex, 
        int realCol, int level, LPCTSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);
int WINAPI SftTreeSplit_FindStringEx_W(HWND hwndCtl, int index, int endIndex, 
        int realCol, int level, LPCWSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);
int WINAPI SftTreeSplit_FindStringEx_A(HWND hwndCtl, int index, int endIndex, 
        int realCol, int level, LPCSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol);

C++

int CSftTree::FindStringEx(int index, int endIndex, int realCol, 
        int level, LPCTSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol) const;
int CSftTreeSplit::FindStringEx(int index, int endIndex, int realCol, 
        int level, LPCTSTR lpszText, BOOL fWrap, BOOL fIgnoreCase, 
        BOOL fExact, BOOL fSearchEnabledOnly, BOOL fSearchVisibleOnly,
        int* lpFoundItem, int* lpFoundCol) const;

Parameters

hwndCtl

The window handle of the tree control.

index

The zero-based item index after which the search begins (non-inclusive). If -1 is specified, the search starts at the first item (index 0).

endIndex

The zero-based item index where the search ends (inclusive). If -1 is specified, all items are searched.

realCol

The zero-based column number. The cell text for cells in this column are searched. If -1 is specified, all columns are searched.

level

The item level to search. Only items on this level (see ItemLevel) are searched. If -1 is specified, all levels are searched.

lpszText

The text to search.

fWrap

If set to TRUE, the search starts at index and wraps around (if necessary) and ends at endIndex, otherwise the search does not wrap around and ends at endIndex.

fIgnoreCase

If set to TRUE, the string comparison between cell text and lpszText is not case sensitive. If FALSE, comparison is case sensitive.

fExact

If set to TRUE, the cell text must be exactly the same as lpszText, otherwise the cell text must start with the string lpszText.

fSearchEnabledOnly

If set to TRUE, only enabled items (see ItemStatus) are searched, otherwise all items regardless of their status are searched.

fSearchVisibleOnly

If set to TRUE, only visible child items (expanded branches) are searched, otherwise all items are searched.

lpFoundItem

A pointer to an integer where the zero-based index of the item where the string was found is returned. Can be set to NULL.

lpFoundCol

A pointer to an integer where the zero-based column number of the cell where the string was found is returned. Can be set to NULL.

Returns

The return value is the zero-based index of the item where the string was found. -1 is returned if the string was not found or an error occurred.

Comments

The FindStringEx function searches cells for a string.

See Also C/C++ API | Categories | Notifications