Sign in Join
FPDoc Onlineexperiment

ExtractSubstr function

In unit StrUtils

Extract a word from a string, starting at a given position in the string.

Declaration

pascal
function ExtractSubstr(const S: string; var Pos: Integer; 
 const Delims: TSysCharSet): string

Arguments

S

String to search in.

Pos

Initial position to start extracting. On exit returns the position of the next word.

Delims

Characters to use as word delimiters.

Function result

The extracted word.

Description

ExtractSubStr returns all characters from S starting at position Pos till the first character in Delims, or till the end of S is reached. The delimiter character is not included in the result. Pos is then updated to point to the next first non-delimiter character in S. If Pos is larger than the Length of S, an empty string is returned.

The predefined constant StdWordDelims can be used for the Delims argument.

Errors

None.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.