Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

ConvertToUnderlines Function

Overview

The ConvertToUnderlines function translates single ‘&’ characters to escaped “&&” characters .

Syntax/Parameters

Syntax

string = ConvertToUnderlines ( string data );

Parameters

data

A string.

Return Value

Returns a string with single ‘&’ converted to double “&&” or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ‘&’ convention indicates underlining in Windows dialogs to denote quick key access. For example, the string “Source && Control” produces “Source & Control” in a Windows dialog control. The ConvertToUnderlines function replaces ‘&’ with “&&”, adding the escape character.

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