Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

GetParameterName Function

Overview

The GetParameterName function returns the name portion of a “property name: value” pair.

Syntax/Parameters

Syntax

string = GetParameterName ( string data );

Parameters

data

A string beginning with a property value pair.

Return Value

Returns a string containing the name of the first property name: value pair or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

Property value pairs commonly occur in CSS and command line scripting. They appear with the following format: “font-size: 10px”. When in a list, a semicolon delimits the property pairs. The GetParamaterName function parses an input string and retrieves the name of the first property. No text can precede the first property value pair in the string, and any other subsequent property value pairs are ignored. If the string is formatted improperly or contains no property value pairs, the GetLastError function will return ERROR_SYNTAX. If the buffer (size 4096 bytes) 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