$Lstr Get Image and $Lstr Set Image: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
(Automatically generated page update) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">$Lstr_Get_Image and $Lstr_Set_Image: Longstring to/from image</span> | <span class="pageSubtitle">$Lstr_Get_Image and $Lstr_Set_Image: Longstring to/from image</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $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.</p> | ||
<var>$Lstr_Get_Image</var> returns the contents of an image as a longstring. <var>$Lstr_Set_Image</var> sets the contents of an image from a longstring. | <var>$Lstr_Get_Image</var> returns the contents of an image as a longstring. <var>$Lstr_Set_Image</var> sets the contents of an image from a longstring. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%lstr</span> = <span class="literal">$Lstr_Get_Image</span>(image) | <p class="syntax"><span class="term">%lstr</span> = <span class="literal">$Lstr_Get_Image</span>(<span class="term">image</span>) | ||
</p> | </p> | ||
<p class=" | <p class="syntax"><span class="term">%rc</span> = <span class="literal">$Lstr_Set_Image</span>(<span class="term">image</span>, <span class="term">value</span>)</p> | ||
===Syntax terms=== | ===Syntax terms=== | ||
| Line 39: | Line 39: | ||
==Products authorizing $Lstr_Get_Image and $Lstr_Set_Image== | ==Products authorizing $Lstr_Get_Image and $Lstr_Set_Image== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Get_Image and $Lstr_Set_Image]] | [[Category:$Functions|$Lstr_Get_Image and $Lstr_Set_Image]] | ||
Latest revision as of 22:52, 20 September 2018
$Lstr_Get_Image and $Lstr_Set_Image: Longstring to/from image
Note: Many $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).