LTrim
Removes surrounding substrings or characters on the left side of a string
Declare Function LTrim Overload ( ByRef str As Const String, [ Any ] ByRef trimset As Const String = " " ) As String
Declare Function LTrim ( ByRef str As Const WString, [ Any ] ByRef trimset As Const WString = WStr(" ") ) As WString
result = LTrim[$]( str [, [ Any ] trimset ] )
str
Returns the trimmed string.
This procedure trims surrounding characters from the left (beginning) of a source string. Substrings matching trimset will be trimmed if specified, otherwise spaces (ASCII code 32) are trimmed.
If the Any keyword is used, any character matching a character in trimset will be trimmed.
All comparisons are case-sensitive.
will produce the output:
Syntax
Declare Function LTrim Overload ( ByRef str As Const String, [ Any ] ByRef trimset As Const String = " " ) As String
Declare Function LTrim ( ByRef str As Const WString, [ Any ] ByRef trimset As Const WString = WStr(" ") ) As WString
Usage
result = LTrim[$]( str [, [ Any ] trimset ] )
Parameters
str
The source string.
trimsetThe substring to trim.
Return Value
Returns the trimmed string.
Description
This procedure trims surrounding characters from the left (beginning) of a source string. Substrings matching trimset will be trimmed if specified, otherwise spaces (ASCII code 32) are trimmed.
If the Any keyword is used, any character matching a character in trimset will be trimmed.
All comparisons are case-sensitive.
Example
Dim s1 As String = " 101 Things to do."
Print "'" + LTrim(s1) + "'"
Print "'" + LTrim(s1, " 01") + "'"
Print "'" + LTrim(s1, Any " 01") + "'"
Dim s2 As String = "BaaBaaBAA Test Pattern"
Print "'" + LTrim(s2, "Baa") + "'"
Print "'" + LTrim(s2, Any "BaA") + "'"
Print "'" + LTrim(s1) + "'"
Print "'" + LTrim(s1, " 01") + "'"
Print "'" + LTrim(s1, Any " 01") + "'"
Dim s2 As String = "BaaBaaBAA Test Pattern"
Print "'" + LTrim(s2, "Baa") + "'"
Print "'" + LTrim(s2, Any "BaA") + "'"
will produce the output:
'101 Things to do.' ' 101 Things to do.' 'Things to do.' 'BAA Test Pattern' ' Test Pattern'
Platform Differences
- DOS version/target of FreeBASIC does not support the wide-character version of LTrim.
Dialect Differences
- The string type suffix "$" is obligatory in the -lang qb dialect.
- The string type suffix "$" is optional in the -lang fblite and -lang fb dialects.
Differences from QB
- QB does not support specifying a trimset string or the ANY clause.
See also
