ExtractWord function

In unit StrUtils

Extract the N-th word out of a string.

Declaration

pascal

function ExtractWord(N: Integer; const S: string; 
 const WordDelims: TSysCharSet): string

Arguments

`N`	Which word to extract.
`S`	String to extract the word from.
`WordDelims`	Characters to use as word delimiters.

Function result

The N-th word, or empty if N is out of range.

Description

ExtractWord extracts the N-th word from the string S. The set of characters in WordDelims are used to mark word boundaries. A word is defined as any non-empty sequence of characters which are not present in WordDelims: if a character is not in WordDelims, it is considered as part of a word. If an N-th word cannot be found, an empty string is returned.

Unlike ExtractDelimited, an empty string is not a valid return value, i.e. is not a word. If an empty string is returned, the index N was out of range.

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

Errors

None.