LEFTF$

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Core Language > BuiltIn Functions > String functions >

LEFTF$

 

Description

 

FAST version of LEFT$ function working on scalar string variable only!

Return the left-most n characters of a string.

 

Syntax

 

s = LEFTF$(StringVariable, nBytes)

 

Returns

 

String

 

Parameters

 

Name

Type

Optional

Meaning

StringVariable

Variable

No

IMPORTANT: a scalar string variable.

 

This parameter can only be:

•a single global or local string variable

•a string element of a user defined type (UDT)

 

nBytes

Numeric

No

Number of bytes to return

 

•if nBytes is greater than or equal to the length of StringExpression, all of StringExpression is returned
 

•if nBytes is zero, LEFTF$ returns an empty string
 

•if nBytes is negative, it is interpreted as:
(LEN(StringExpression) - ABS(nBytes))
 
For example:
 
String s = "thinBasic"
LEFTF$(s, -5) '---returns "thin"
 

•if nBytes is negative but its absolute value is greater than or equal to the length of StringExpression, all of StringExpression is returned
 
For example:
 
String s = "thinBasic"
LEFTF$(s, -10) '--returns "thinBasic"

 

 

Remarks

 

Restrictions

 

See also

 

String Handling, LEFT$, RIGHT$, MID$, RIGHTF$,

 

Examples

 

 

 

History

 

thinBasic Version

Date

Changes

1.12.0

2024/07/02

Added possibility to have negative values in nBytes parameter