ObjectType:string
Jump to navigation
Jump to search
Contents
Description
A string, also known as text is a series of consecutive characters.
Members
- string Mid[position,length]: Returns a string containing the given length at the given position (1-based) of the original string
- string Left[#]: Returns a string containing the leftmost # characters of the original string. A negative number can be used to give the leftmost (Length-#)
- string Right[#]: Returns a string containing the rightmost # characters of the original string. A negative number can be used to give the rightmost (Length-#)
- int Find[text]: Returns the 1-based position of a given substring in the original string, or NULL
- int Length: Returns the length of the string
- string Upper: Returns a string containing the original string in all upper case
- string Lower: Returns a string containing the original string in all lower case
- int Compare[text]: Compares this string, without regards to case, to the given text. Return value is less than 0 if the text would come before it in the dictionary, 0 if it is equal, or greater than 0 if the text would come after the string
- int CompareCS[text]: Compares this string, with regards to case, to the given text. Return value is less than 0 if the text would come before it in the dictionary, 0 if it is equal, or greater than 0 if the text would come after the string
- bool Equal[text]: TRUE if the string is equal to, without regards to case, the given text
- bool NotEqual[text]: TRUE if the string is not equal to, without regards to case, the given text
- bool EqualCS[text]: TRUE if the string is equal to, with regards to case, the given text
- bool NotEqualCS[text]: TRUE if the string is not equal to, with regards to case, the given text
- int Count[char]: The number of times a specific character appears in the string
- string Token[#,separator]: "Tokenizes" the string by the given separator and returns the #th token
- string Escape: Uses slashes to escape \, ", carriage return, line feed, tab, as well as LavishScript data sequences
- string EscapeQuotes: Uses slashes to escape " only
- string Replace[character,with,...]: Performs single-character replacement with any number of character pairs
Methods
(none)
Declaring string Variables
- Any string variable is a mutablestring
- declare Food string "Pizza"
- declare Word string script
Comparing Strings
declare name1 string "fred" declare name2 string "george" if ${name1.Equal[${name2}]} { echo We're both named fred! }
Operates On
const char *