EmEditor Home - EmEditor Help - Plug-in Reference - Inline Functions

Editor_FindA

Searches an ANSI string. You can use this inline function or explicitly send the EE_FINDA message.

Editor_FindA( HWND hwnd, UINT nFlags, LPCSTR szFind )

Parameters

hwnd

Specifies the window handle of the view or frame of EmEditor.

nFlags

You can specify a combination of the following values.

Value Meaning
FLAG_FIND_AROUND Moves to start/end of the text.
FLAG_FIND_BOOKMARK Sets bookmarks on lines where the string is matched.
FLAG_FIND_CASE Matches cases.
FLAG_FIND_COUNT Counts the occurrences of the matched string.
FLAG_FIND_EMBEDDED_NL Matches embedded newlines in CSV documents and does not match other newlines.
FLAG_FIND_ESCAPE Uses escape sequences.
FLAG_FIND_EXTRACT Extracts matched lines to a new document.
FLAG_FIND_FILTER Shows the Filter toolbar and shows only the lines that match the specified string. If this flag is specified, you can't also specify FLAG_FIND_AROUND, FLAG_FIND_BOOKMARK, FLAG_FIND_COUNT, FLAG_FIND_EXTRACT, FLAG_FIND_NEXT, FLAG_FIND_OPEN_DOC, FLAG_FIND_NO_PROMPT, FLAG_FIND_SEL_ONLY, FLAG_FIND_SAVE_HISTORY, or FLAG_FIND_SELECT_ALL flags.
FLAG_FIND_NEGATIVE Shows the Filter toolbar and excludes the lines that match the specified string. This flag must be specified with the FLAG_FIND_FILTER flag.
FLAG_FIND_NEXT Searches the string downward from the cursor position. If this flag is not set, searches the string upward.
FLAG_FIND_NO_PROMPT Suppresses displaying a dialog box even if no string is found.
FLAG_FIND_ONLY_WORD Searches only words.
FLAG_FIND_OPEN_DOC Searches all open documents in the same frame window.
FLAG_FIND_REG_EXP Uses a regular expression.
FLAG_FIND_SAVE_HISTORY Saves the searched string for repeated search.
FLAG_FIND_SELECT_ALL Selects all matched strings.
FLAG_FIND_SEL_ONLY Searches only in the selection.

szFind

Specifies a string to search.

Return Values

Returns 1 if the searched string is found, or 0 if not found. However, if the FLAG_FIND_COUNT flag is specified, the return value is the number of the occurrences of the matched string in the document. Nevertheless, if the searched string is not found from the cursor position toward the specified direction, the return value is 0 even it the matched string is found in the rest of the document. If the FLAG_FIND_FILTER flag is specified, the return value is the number of the lines that match the specified string. If the specified string is an empty string and the FLAG_FIND_FILTER flag is specified, the return value is -1.

Copyright 2003-2015 by Emurasoft, Inc.