Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

SetScriptDescription Function

Overview

The SetScriptDescription function sets the script’s description.

Syntax/Parameters

Syntax

string = SetScriptDescription ( string value );

Parameters

value

A string containing the new script description. The string cannot be larger than 512 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 description 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