Trim
Removes surrounding substrings or characters on the left and right side of a string
Syntax
`
Declare Function Trim ( ByRef str As Const String, [ Any ] ByRef trimset As Const String = " " ) As String
Declare Function Trim ( ByRef str As Const WString, [ Any ] ByRef trimset As Const WString = WStr(" ") ) As WString
`
Usage
`
result = Trim[$]( str [, [ Any ] trimset ] )
`
Parameters
`str`
The source string.
`trimset`
The substring to trim.
Return Value
Returns the trimmed string.
Description
This procedure trims surrounding characters from the left (beginning) and right (end) 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 = " ... Stuck in the middle ... "
Print "'" + Trim(s1) + "'"
Print "'" + Trim(s1, Any " .") + "'"
Dim s2 As String = "BaaBaaaaB With You aaBBaaBaa"
Print "'" + Trim(s2, "Baa") + "'"
Print "'" + Trim(s2, Any "Ba") + "'"
`
will produce the output:

    '... Stuck in the middle ...'
    'Stuck in the middle'
    'aaB With You aaB'
    ' With You '

Platform Differences

- DOS version/target of FreeBASIC does not support the wide-character version of `Trim`.

Dialect Differences

- Not available in the -lang qb dialect unless referenced with the alias `__Trim`.
- The string type suffix "$" is optional in the -lang fblite and -lang fb dialects.

Differences from QB

- New to FreeBASIC

See also

- LTrim
- RTrim