Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter FourFlow Control (continued)

GetSessionWord Function

Overview

The GetSessionWord function returns a 64-bit, unsigned integer value as converted from the data value associated with a specified name, section and group.

Syntax/Parameters

Syntax

qword = GetSessionWord ( [string group], [string section], string name );

Parameters

group

An optional string specifying a qualifying group. The value cannot be larger than 127 bytes.

section

An optional string specifying a qualifying section. The value cannot be larger than 127 bytes.

name

A string specifying the name of the value. The value cannot be larger than 127 bytes.

Return Value

Returns an qword as the translated value or zero on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage to retrieve additional details. Note that zero can be the translated value without an error.

Remarks

The string value is expected to be in hexadecimal form. If that value cannot be translated, a syntax error will be set in the last error value.

Related Functions

Platform Support

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

Legato IDE, Legato Basic