$Lstr_Global_Get and $Lstr_Session_Get

From m204wiki
Revision as of 20:32, 24 October 2012 by JALWiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

$Lstr_Global_Get and $Lstr_Session_Get

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no OO equivalent for the $Lstr_Global_Get and $Lstr_Session_Get functions.

This function retrieves the value of a global or session longstring. If the global or session longstring has never been set it returns a null.

$Lstr_Global_Get and $Lstr_Session_Get accept one argument and returns a string result.

The first argument is a string containing the name of the global or session longstring. This is a required argument.

Syntax

<section begin="syntax" />%LSTR = $Lstr_Global_Get(gname) <section end="syntax" />

$Lstr_Global_Get Function

%LSTR is set to the value of the global longstring.

%LSTR = $Lstr_Session_Get(gname)

$Lstr_Session_Get Function

%LSTR is set to the value of the session longstring.

$Lstr_Global_Get and $Lstr_Session_Get are roughly analogous to the $GETG function for longstrings. $Lstr_Global_Get and $Lstr_Session_Get will return the current value of a global or session longstring whether or not that longstring is bound in the current request via $Lstr_Global or $Lstr_Session. However, if a global or session longstring value is to be retrieved and updated frequently in a request it is generally better to bind that longstring to a %variable using $Lstr_Global or $Lstr_Session. In the following example, the value of the global longstring named "POLLY&CQ. is retrieved into the longstring %PARROT.

%PARROT = $Lstr_Global_Get('POLLY')

$Lstr_Global_Get and $Lstr_Session_Get have independent namespaces. That is, the same name used for $Lstr_Global_Get and $Lstr_Session_Get reference different longstrings. A $Lstr_Session_Get call when there is no session open causes a request cancellation.

While the $Lstr_Global_Get and $Lstr_Session_Get are longstring capable the global names themselves cannot be longer than 255 bytes. An attempt to use a longer name results in a request cancellation truncation error.

You can clean up any global longstrings with $Lstr_Global_Del and any session longstrings with $Lstr_Session_Del.

$Lstr_Global_Get and $Lstr_Session_Get are new in Version 6.3 of the Sirius Mods.

Products authorizing $Lstr_Global_Get and $Lstr_Session_Get

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Global_Get_and_$Lstr_Session_Get&oldid=35025"