Show: Delphi C++
Display Preferences

System.StrUtils.SearchBuf

From XE2 API Documentation
Jump to: navigation, search

Delphi

function SearchBuf(Buf: PAnsiChar; BufLen: Integer; SelStart, SelLength: Integer; SearchString: AnsiString; Options: TStringSearchOptions): PAnsiChar;
function SearchBuf(Buf: PWideChar; BufLen: Integer; SelStart, SelLength: Integer; SearchString: UnicodeString; Options: TStringSearchOptions): PWideChar;

C++

extern PACKAGE char * __fastcall SearchBuf(char * Buf, int BufLen, int SelStart, int SelLength, System::AnsiString SearchString, TStringSearchOptions Options = (TStringSearchOptions() << TStringSeachOption::soDown ))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.StrUtils.pas
System.StrUtils.hpp
System.StrUtils System.StrUtils

Description

Locates a substring within a text buffer.

Call SearchBuf to search for a specified search string within a text buffer.

Buf is the text buffer to search.

BufLen is the length, in bytes, of Buf.

SelStart is the first character of the search when Options indicates a backward search (does not include soDown). The first character in Buf has position 0.

SelLength is the number of characters after SelStart that the search begins when Options indicates a forward search (includes soDown).

SearchString is the string to find in Buf.

Options determines whether the search runs forward (soDown) or backward from SelStart or SelStart+SelLength, whether the search is case sensitive (soMatchCase), and whether the matching string must be a whole word (soWholeWord).

If SearchBuf finds a match, it returns a pointer to the first character of the matching string in Buf. If it does not find a match, SearchBuf returns nil (Delphi) or NULL (C++).

See Also

Personal tools
Previous Versions
Translations