Left

From Xojo Documentation

You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!
fa-info-circle-32.png
Left (the global function) is here for compatibility with Visual Basic. You should instead use String.Left.
Method

Returns the first n characters in a source string.

Syntax

result=sourceVariable.Left(count)

Part Type Description
result String The first count characters of source.
sourceVariable String The source string from which to get the characters.
count Integer The number of characters you wish to get from source.

If count is greater than the number of characters in source, all characters are returned.

Notes

The Left function returns characters from the source string starting from the left side (as the name implies).

If you need to read bytes rather than characters, use the MemoryBlock class.

Examples

This example returns the first five characters in a string.

Var source As String = "Hello World"
source = source.Left(5) // returns "Hello"

See Also

String for a complete list of functions.