$Lstr Global Set and $Lstr Session Set: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
| Line 14: | Line 14: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%rc</th> | <tr><th>%rc</th> | ||
<td>A numeric return code that is set to 0 for success or, if CCATEMP is full and the LISTFC parameter is not set | <td>A numeric return code that is set to 0 for success, or to -3, if CCATEMP is full and the LISTFC parameter is not set.</td></tr> | ||
<tr><th>gname</th> | <tr><th>gname</th> | ||
Revision as of 00:11, 26 October 2012
$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.
Syntax
<section begin="syntax" />%rc = $Lstr_Global_Set(gname, value) <section end="syntax" />
%rc = $Lstr_Session_Set(gname, value)
Syntax terms
| %rc | A numeric return code that is set to 0 for success, or to -3, if CCATEMP is full and the LISTFC parameter is not set. |
|---|---|
| gname | A string containing the name of the global or session longstring. This is a required argument. |
| value | A longstring containing the value to which to set the global or session longstring. This is a required argument. |
Usage notes
- $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.
- $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.
Example
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)