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

Table of Contents	< < Previous	Next >>

 

Chapter Four — Flow Control (continued)

DecrementSessionValue Function

Overview

The DecrementSessionValue function decrements a session value by one on an atomic basis and returns the value prior to decrementing.

Syntax/Parameters

Syntax

int = DecrementSessionValue ( [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 int as the previous value. Use the IsError, IsNotError and GetLastError functions to retrieve a formatted error code and GetLastErrorMessage to retrieve additional details..

Remarks

The process is completed on an atomic basis to be used to index tables, other data, or count down. When starting a process, the program should set an initial value using the SetSessionValue function. If the name value does not exist, it is created and set to zero.

When the function is called, it guarantees that the value returned will not be returned to any other thread calling the function.

That value is stored as a decimal string.

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.

IncrementSessionValue — Increments a session value on a thread-safe basis and returns the result.

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

SetSessionValue — Sets a named session value.

WaitForObject — Waits for an object with an optional specified time.

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.