ObjectType:string

From Lavish Software Wiki
(Redirected from DataType:string)
Jump to: navigation, search
Object Type Vitals
string
Defined By LavishScript
Inherits none
Reduces To the stored text
Variable Object Type mutablestring
Uses Sub-Types no
C/C++ Type const char *

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
  • byte GetAt[#]: Retrieves a character at the #th position in the string (1-based)
  • unistring unistring:
  • string URLEncode: Returns a %u encoded version of the string, suitable for urls
  • bool NotNULLOrEmpty: TRUE if the string is not empty and does not contain the literal NULL. This provides a shortcut for: if ${MyString.Length} && !${MyString.Equals[NULL]}

Methods

(none)

Declaring string Variables

  • Any string variable is automatically a mutablestring
  • variable string Food="Pizza"

Comparing Strings

variable string name1="fred"
variable string name2="george"
if ${name1.Equal[${name2}]}
{
    echo We're both named fred!
}

See Also

LavishScript Object Types

Text
string - mutablestring - unistring
Numbers
byte - float - float64 - int - uint - int64
Boolean (TRUE/FALSE)
bool
Pointers
boolptr - byteptr - floatptr - float64ptr - intptr - uintptr - int64ptr - rgbptr - stringptr
Containers
objectcontainer - array - index - collection - queue - stack - set - variablescope
JSON
jsonobject - jsonarray - jsonvaluecontainer - jsonvalue
Iteration
iterator - jsoniterator
Date/Time
time
Other
point3f - rgb - script - binary - event - enumtype
File Handling
filepath - file - filelist - filelistentry
Utilities
exists - lavishscript - math - system - type - variable
Tasks
lavishmachine - Accessed via the Top-Level Object LMAC
task - tasklibrary - taskmanager - tasktype - taskpulseargs - elmactaskstate