Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FiveGeneral Functions (continued)

SetScriptName Function

Overview

The SetScriptName function sets the script’s given name.

Syntax/Parameters

Syntax

int = SetScriptName ( string value );

Parameters

value

A string containing the new script name. The string cannot be larger than 48 characters.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. The only failure mode is a string overflow in which case the string is truncated before setting the script name.

Remarks

The script given name can be used to help identify the script. It is not used directly by any function except for retrieving the name or when scripts are enumerated.

Any syntax can be used for the string.

Related Functions

Platform Support

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

Legato IDE, Legato Basic