Arbortext Command Language > Functions by Alphabetical Listing > find
  
find
find(searchStr[, flags[, element[, doc]]])
 
This function searches for the specified string searchStr. The search ignores generated text and returns 1 on success, 0 on failure.
searchStr — String to search for.
flags — Bit mask for modifying the search.
0x0001 - backward search (-b)
0x0002 - case sensitive search (-c)
0x0004 - searchStr is regular expression (-e)
0x0008 - whole word only search
0x0010 - searchStr contains markup (-markup)
0x0020 - quiet search (-q) default is (-noq)
0x0040 - don't prompt for wrapping at end of instance (-wrapprompt)
0x0080 - wrap search (-wrapscan)
0x0100 - don't wrap search (-nowrapscan) default is -wrapscan preference
0x0200 - select searchStr when found (-select)
0x0400 - don't select searchStr when found (-noselect) default is -selectscan preference
0x0800 - search contents of entities (-entityscan)
0x1000 - don't search contents of entities (-noentityscan) default is -entityscan preference
0x2000 - search for next equation (-equation) searchStr ignored
0x4000 - search for next image (-image) searchStr ignored
0x8000 - search for next table (-table) searchStr ignored
0x10000 - selection will be unbalanced regardless of the balancedselections Advanced Preference and set option.
element — Search only the contents of elements with this name.
doc — Current document instance is used if not specified.