User Tools

Site Tools


syntax:functions:startswith

StartsWith(text, start_string)

Category: Text function


Description

This function is a search function used to check if a string (text) starts with a specific text value (start_string). If so, this function returns TRUE. Otherwise, it returns FALSE.


Arguments

ArgumentTypeDescription
textTextAny text, or value that can implicitly converted to text.
start_stringTextThe text string to search for at the beginning of text.

Return value type: Boolean (TRUE/FALSE)


Remarks

This function is case sensitive.

This function ignores leading whitespace and other non-printing characters when matching start_string to the beginning of text.


Examples

startswith( 'Crimea', 'Crime' ) //Returns TRUE
startswith( 'IBM', 'i' ) //Returns FALSE (unmatched due to case)
startswith('    Ruthless', ' Ruth') //Returns TRUE (leading whitespace ignored)


See also

syntax/functions/startswith.txt · Last modified: 2021/08/14 19:01 by craigt

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki