Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

ConvertFromEscapeCharacters Function

Overview

The ConvertFromEscapeCharacters removes escape notation from particular characters within a string.

Syntax/Parameters

Syntax

string = ConvertFromEscapeCharacters ( string data );

Parameters

data

A string to convert.

Return Value

Returns a string with escape notation removed on some characters (see Remarks) or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ConvertFromEscapeCharacters function removes escape notation (‘\’) from the following characters:

  \ Backslash
  \b Backspace
  \f Form feed/page break
  \n New line
  \r Carriage return
  \t Tab

 

Other characters that may be escaped within the string will not be affected.

The return string has a maximum size of 1 MB. If the buffer is exceeded, the GetLastError function will return ERROR_OVERFLOW.

Related Functions

Platform Support

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

Legato IDE, Legato Basic