GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Four — Flow Control (continued)

EnumerateSessionData Function

Overview

The EnumerateSessionData function enumerates all the named values within the session data pool.

Syntax/Parameters

Syntax

string [][] = EnumerateSessionData ( );

Parameters

(none)

 

Return Value

Returns a two-dimensional string table of all session data or empty on failure or if there are no entries. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage to retrieve additional details.

Remarks

The string table has the following column keys:

	Key Name		Description
	group		Group name, if provided.
	section		Section name, if provided.
	name		Value name.
	data		Data being stored. For signed integers, a string representation of a decimal value. For unsigned integers, a string representation of a hexadecimal value.
	handle		A hexadecimal representation of the handle for the script that last updated the entry.
	time_stamp		A decimal representation as a time stamp as the system tick count.

 

Related Functions

DeleteSessionValue — Deletes a named session value.

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.

GetTickCount — Gets the system tick count from the system start up.

MakeHandle — Converts an integer or formatted string to a handle value. The string can be hex, octal or decimal.

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 12/16/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.