String Manipulation Functions

<sidebar>Sidebar: Editing Icon Properties</sidebar>

See Calculation Icon Properties

The String functions are a set of string manipulation functions that can be used to edit, change and examine the strings.

To add a function, drag it into the calculation box. The user can then edit this base code with the variables required.

Example Strings used in explaining the functions below:

Str1[20] = "Hello "

Str2[10] = "World"

TestStr[20]

=

Changes the string to the string given. If the array.

If the string is longer than the array size then any extra characters are lost.

TestStr = Str1 + Str2

TestStr is now "Hello World"

+

Concatenates the two string together in the order presented from left to right.

If the resulting string is longer than the array size of the receiving string then any extra characters are lost.

TestStr = Str1 + Str2

TestStr is now "Hello World"

ToString$(value)

Changes the numeric value to a String.

TestStr = ToStr$(1234)

TestStr is now "1234"

ToUpper$(string)

Changes all letters to upper case.

TestStr = ToUpper$(Str1)

TestStr is now "HELLO "

ToLower$(string)

Changes all letters to lower case.

TestStr = ToLower$(Str1)

TestStr is now "hello "

Length$(string)

Retrieves the length of the string.

This is not the Array size, but the number of characters in the array before a Null character is encountered.

RetVal = Length$(Str1)

RetVal is now 6

Note: Str1 array size is 20, but has a String of only 6 characters currently assigned to it hence the return value of 6.

Left$(string, size) Retrieves a substring from the string of size characters starting from the leftmost character.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Left$(Str1, 3)

TestStr is now "Hel"

Right$(string, size)

Retrieves a substring from the string of size characters starting from the rightmost character.

i.e. a size of 4 retrieves the 4 rightmost characters.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Right$(Str1, 3)

TestStr is now "lo "

Mid$(string, start, size)

Retrieves a substring from the string starting at position start of size characters.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Mid$(Str1, 2, 3)

TestStr is now "llo"

Compare$(string1, string2, compare_type)

Compares the two strings, parameters 1 and 2, and returns a BYTE value corresponding to the following results:

0 = strings are identical

1 = string1>string2

255 = string2>string1

The 3rd parameter, compare_type, determines whether or not the check is case sensitive. values for compare_type are:

0 = case sensitive

1 = case insensitive.

Examples

Str1 = "ABC"

Str2 = "abc"

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 255 as Str2 is later in the ASCII sequence.

RetVal = Compare$(Str1, Str2, 1)

RetVal is now 0 as when case insensitive the two strings are identical.

Str2 = Str1

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 0 as both strings are identical.

FloatToString$( float )

Converts a floating point number into a string.

float = Floating point number to convert.

string = String variable to hold the conversion data.

string = FloatToString( float )

NumberToHex$( number )

Converts a byte or int number into a hexadecimal string.

number = byte or integer number to convert.

string = String variable to hold the conversion data.

string = FloatToString( INT )

StringToInt$(string)

Converts a string of numeric ASCII data into an integer numeric data value.

string = String variable containing numeric ASCII data.

returns numeric data from the string in decimal form.

number = StringToInt$( string )

StringToFloat$( string )

Converts a string of numeric ASCII data into a floating point variable.

string = String variable containing numeric ASCII data.

returns numeric data from the string in floating point form.

float = StringToFloat$( string )