JCL Help:TSearchEngine.FindFirst@PWideChar@SizeInt@SizeInt@SizeInt

 JCL Help: TSearchEngine.FindFirst Method (PWideChar, SizeInt, SizeInt, SizeInt)

TSearchEngine

► TSearchEngine Methods

[+] TSearchEngine Methods

► TSearchEngine Properties

[+] TSearchEngine Properties

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Finds the first occurence of a search pattern.

Pascal

 public function FindFirst(const Text: WideString; var Start: SizeInt; var Stop: SizeInt): Boolean; virtual; abstract; overload;
public function FindFirst(Text: PWideChar; TextLen: SizeInt; var Start: SizeInt; var Stop: SizeInt): Boolean; virtual; abstract; overload;

Parameters

Parameters	Description
const Text: WideString	Text to be searched.
var Start: SizeInt	Start index of match if the function returned True, otherwise undefined.
var Stop: SizeInt	End index of match if the function returned True, otherwise undefined.
TextLen: SizeInt	Length of text (available only in the PWideChar version).

Return Value

True is the pattern provided in FindPrepare was found in the Text parameter, False otherwise.

Description

FindFirst finds the first occurence of the pattern passed to FindPrepare in Text and returns True if one could be found (in which case Start and Stop are set to the according indices) otherwise False. This function is in particular of interest if only one occurence needs to be found.

See Also

FindAll

About

Donator

Mike Lischke

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository