$Lstr_Global_Set and $Lstr_Session_Set

From m204wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

$Lstr_Global_Set and $Lstr_Session_Set

Note: Many $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

%rc = $Lstr_Global_Set(gname, value)

%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)

Products authorizing $Lstr_Global_Set and $Lstr_Session_Set