Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

TrimString Function

Overview

The TrimString function returns a copy of a string with all of the trailing white or word space characters.

Syntax/Parameters

Syntax

string  = TrimString ( string data );

wstring = TrimString ( wstring data );

Parameters

data

A string or wstring specifying the source data to be trimmed.

Return Value

Returns a string or wstring containing data trimmed or an empty string on failure.

Remarks

The TrimString function removes the following characters: 

  Decimal   Hexadecimal   Escape Code   Description
  32   0x20     Space
  8   0x08   \b   Backspace
  9   0x09   \t   Horizontal tab
  10   0x0A   \n   New line
  12   0x0C   \f   Form feed
  13   0x0D   \r   Carriage return

The size of the returned string can be retrieved by using the GetLastError function. This can reduce processing time for exceptionally large strings.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic