$Lstr Get Image and $Lstr Set Image: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
(Automatically generated page update) |
||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">%lstr = $Lstr_Get_Image(image) | <p class="syntax"><span class="term">%lstr</span> = <span class="literal">$Lstr_Get_Image</span>(image) | ||
</p> | </p> | ||
Revision as of 23:39, 12 April 2013
$Lstr_Get_Image and $Lstr_Set_Image: Longstring to/from image
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There are no OO equivalents for the $Lstr_Get_Image and $Lstr_Set_Image functions.
$Lstr_Get_Image returns the contents of an image as a longstring. $Lstr_Set_Image sets the contents of an image from a longstring.
Syntax
%lstr = $Lstr_Get_Image(image)
%rc = $Lstr_Set_Image(image, value)
Syntax terms
| %lstr | A longstring to receive the contents of the image. |
|---|---|
| %rc | A numeric variable to receive the count of bytes set in the image. |
| image | A string containing the name of the image to which the function applies. This is a required argument. |
| value | The longstring from which the image in the image argument is to be set. |
Usage notes
- $Lstr_Get_Image and $Lstr_Set_Image can be useful for maintaining :
- Multiple copies of or versions of an image in a single request
- One or more global copies of an image (using global Longstrings) without using the GTBL space required by the standard GLOBAL IMAGE feature
- Copies of an image associated with a session that survives a logout (using session Longstrings).