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

Table of Contents	< < Previous	Next >>

 

Chapter Four — Flow Control (continued)

GetSessionString Function

Overview

The GetSessionString function returns the raw string for a session data value associated with a specified name, section and group.

Syntax/Parameters

Syntax

string = GetSessionString ( [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 a string containing a copy of the data specified by the name components or empty on failure. Since an empty string can be a valid value, IsError or IsNotError should be used to determine if a failure occurred. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage to retrieve additional details.

Remarks 

An empty string for section or group is the same as not providing the parameter. Exceeding 127 bytes for any name component will result in a runtime error.

Integer values may also be returned in string form.

Related Functions

DeleteSessionValue — Deletes a named session value.

EnumerateSessionData — Enumerates all named session values and properties.

GetSessionInteger — Gets a session value as an integer.

GetSessionPoolSize — Returns the overall size of the application session pool.

GetSessionString — Gets a session value as a string.

GetSessionWord — Gets a session value as an unsigned word.

ResetSessionData — Resets all session data (deletes all named values).

SetSessionValue — Sets a named session value.

TestAndSetSessionValue — Tests and sets for a session value on a thread-safe basis and returns the result.

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.