$Lstr_Global_Get and $Lstr_Session_Get
Jump to navigation
Jump to search
$Lstr_Global_Get and $Lstr_Session_Get
Note: Many $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.
Syntax
%lstr = $Lstr_Global_Get(gname)
%lstr = $Lstr_Session_Get(gname)
Syntax terms
| %lstr | A longstring set to the value of the global or session longstring. |
|---|---|
| gname | A string containing the name of the global or session longstring. This is a required argument. |
Usage notes
- $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.
- $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.
Example
In the following example, the value of the global longstring named POLLY is retrieved into the longstring %PARROT.
%PARROT = $Lstr_Global_Get('POLLY')