$Lstr_Get_Image and $Lstr_Set_Image

From m204wiki
Revision as of 21:16, 8 July 2012 by JAL2 (talk | contribs)
Jump to navigation Jump to search

$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.

$Lstr_Get_Image accepts one argument and returns a longstring result. $Lstr_Set_Image accepts two arguments and returns a numeric result.

The first argument to both $Lstr_Get_Image and $Lstr_Set_Image is a string containing the name of the image to which the function applies. This is a required argument.

The second argument to $Lstr_Set_Image is the longstring from which the image indicated by argument 1 is to be set.

Syntax

<section begin="syntax" /> %LSTR = $Lstr_Get_Image(image) <section end="syntax" />

$Lstr_Get_Image Function

%LSTR is set to the contents of the image.

%RC = $Lstr_Set_Image(image, value)

$Lstr_Set_Image Function

%RC is set to the bytes set in the image.

$Lstr_Get_Image and $Lstr_Set_Image can be useful for maintaining multiple copies of or versions of an image in a single request, for maintaining one or more global copies of an image (using global LONGSTRINGs) without using the GTBL space required by the standard GLOBAL IMAGE feature and for maintaining copies of an image associated with a session that survives a logout (using session LONGSTRINGs).

$Lstr_Get_Image and $Lstr_Set_Image are new in Version 6.3 of the Sirius Mods.

Products authorizing $Lstr_Get_Image and $Lstr_Set_Image