$Lstr_Global_Set and $Lstr_Session_Set

From m204wiki
Revision as of 19:48, 25 October 2012 by JALWiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

$Lstr_Global_Set and $Lstr_Session_Set

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are not OO equivalent for the $Lstr_Global_Set and $Lstr_Session_Set functions.

This function sets the value of a global or session longstring. If the global or session longstring has never been set or bound to a %variable it is created.

$Lstr_Global_Set and $Lstr_Session_Set accept two arguments and returns a 0 for success or a -3 if CCATEMP is full and the LISTFC parameter is not set.

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

The second argument is a longstring containing the value to which to set the global or session longstring. This is a required argument.

Syntax

<section begin="syntax" />%rc = $Lstr_Global_Set(gname, value) <section end="syntax" />

$Lstr_Global_Set Function

%RC is set to 0 or, if CCATEMP is full, to -3.

%RC = $Lstr_Session_Set(gname, value)

$Lstr_Session_Set Function

%RC is set to 0 or, if CCATEMP is full, to -3.

$Lstr_Global_Set and $Lstr_Session_Set are roughly analogous to the $SETG function for longstrings. $Lstr_Global_Set and $Lstr_Session_Set will set 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. A longstring %variable bound to the global or session longstring set by these functions immediately reflects the new value of the global or session longstring. 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" is set to the value in longstring %CRACKER.

%RC = $Lstr_Global_Set('POLLY', %CRACKER)

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

While the $Lstr_Global_Set and $Lstr_Session_Set 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_Set and $Lstr_Session_Set are new in Version 6.3 of the Sirius Mods.

Products authorizing $Lstr_Global_Set and $Lstr_Session_Set

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Global_Set_and_$Lstr_Session_Set&oldid=35058"