GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

ConvertToEscapeCharacters Function

Overview

The ConvertToEscapeCharacters adds escape notation to particular characters within a string.

Syntax/Parameters

Syntax

string = ConvertToEscapeCharacters ( string data );

Parameters

data

A string to convert.

Return Value

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

Remarks

The ConvertToEscapeCharacters function adds 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 need to 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

ConvertFromEscapeCharacters — Copies from escaped characters (with backslash such as \r or \n).

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.