Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

ConvertWordSpaces Function

Overview

The ConvertWordSpaces function converts all word space characters to single space characters (0x20/32) within a string.

Syntax/Parameters

Syntax

string = ConvertWordSpaces ( string data );

Parameters

data

A string.

Return Value

Returns a string with any white spaces characters converted to single space characters or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ConvertWordSpaces function is useful when processing text for HTML or XML where there may be extraneous new lines, returns, and spaces in the string. The following word space or white space characters are checked:

  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 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