Tutorial

Last updated on: September 02, 2024
Also available as a single HTML file

Onetastic Macro Documentation > Functions > String Functions > String_FindFirstOf

String_FindFirstOf

Finds the first occurence of any of the given characters in an input string. Returns true if one was found and the offset it was found at, false otherwise.

Syntax

Bool String_FindFirstOf(
	String string, 
	String characters, 
	Numeric offset, 
	out Numeric foundAt)

Parameters

String string: String to search in.
String characters: The set of characters to look for.
Numeric offset: Offset of the input string to start search from. If non-negative, search will start this number of characters counted from the beginning of the string. If negative, the search will start this number of characters counted from the end of the string.
out Numeric foundAt: If any of the characters is found, the offset of the first occurence is stored in this variable.

Examples

// 1 2 3 4 // 01234567890123456789012345678901234567890 $string = "a4 b6 c5 4a b6 d5 f6 d7 e4 b6 c2 56 d4 5a" // ^ ^ ^ ^ // Instances of c, 7 and f are marked with ^ // Find first instance of c, 7, or f String_FindFirstOf($string, "c7f", 0, $foundAt) // Returns true, $foundAt is 6 // Find first instance after index 9 String_FindFirstOf($string, "c7f", 9, $foundAt) // Returns true, $foundAt is 18 // Find first instance within the last 20 characters String_FindFirstOf($string, "c7f", -20, $foundAt) // Returns true, $foundAt is 22 // Not found String_FindFirstOf($string, "abc", 0, $foundAt) // Returns false, $foundAt is not modified

Tutorial

String_FindFirstOf

Syntax

Parameters

Examples

See Also

Reference