$ListSav and $ListSave - Revision history

JAL: minor formatting

2018-06-06T21:56:30Z

minor formatting

← Older revision		Revision as of 21:56, 6 June 2018
Line 78:		Line 78:
	<code>MY.GLOBAL.LIST</code> would still be a valid global $list, but it would be empty.		<code>MY.GLOBAL.LIST</code> would still be a valid global $list, but it would be empty.

	<li>The only difference between <var>$ListSav</var> and <var>$ListSave</var> is that <var>$ListSav</var> will not allow the saving of an empty $list while <var>$ListSave</var> will and that <var>$ListSave</var> will replace an existing saved $list by the same name as long as the existing list is not active as a <var>$List_Global</var> list in the current procedure. For example, in		<li>The only difference between <var>$ListSav</var> and <var>$ListSave</var> is that <var>$ListSav</var> will not allow the saving of an empty $list while <var>$ListSave</var> will and that <var>$ListSave</var> will replace an existing saved $list by the same name as long as the existing list is not active as a <var>$List_Global</var> list in the current procedure. For example, in the following the second <var>$ListSav</var> would fail because a $list is already saved under the name <code>A.LITTLE.LIST</code>:

	<p class="code">%RESULT = $ListSav(%ALIST, 'A.LITTLE.LIST')		<p class="code">%RESULT = $ListSav(%ALIST, 'A.LITTLE.LIST')
Line 84:		Line 84:
	</p>		</p>

	the second <var>$~~ListSav~~</var> would ~~fail because a $list is already saved under the name <tt>A.LITTLE.LIST</tt>. While in~~		While the second <var>$ListSave</var> below would succeed:

	<p class="code">%RESULT = $ListSave(%ALIST, 'A.LITTLE.LIST')		<p class="code">%RESULT = $ListSave(%ALIST, 'A.LITTLE.LIST')
	%RESULT = $ListSave(%BLIST, 'A.LITTLE.LIST')		%RESULT = $ListSave(%BLIST, 'A.LITTLE.LIST')
	</p>		</p>

	~~the second <var>$ListSave</var> would succeed.~~
	</ul>		</ul>

JAL: misc cleanup

2018-06-06T21:52:31Z

misc cleanup

← Older revision		Revision as of 21:52, 6 June 2018
Line 2:		Line 2:
	<span class="pageSubtitle">$ListSav and $ListSave: Save global $list</span>		<span class="pageSubtitle">$ListSav and $ListSave: Save global $list</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $ListSav and $ListSave functions because Stringlists can, more naturally, be declared as "Global".</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the <var>$ListSav</var> and <var>$ListSave</var> functions because <var>Stringlists</var> can, more naturally, be declared as "Global". </p>

	These [[Calling Sirius Mods $functions\|callable]] $functions are used to save a $list to be later retrieved with the <var>[[$ListRst]]</var> function or the <var>[[$List_Global and $List_Session\|$List_Global]]</var> and <var>[[$List_Global and $List_Session\|$List_Session]]</var> functions. <var>$ListSav</var> and <var>$ListSave</var> are used with <var>$ListRst</var> or <var>$List_Global</var> to pass a $list between separate requests.		These [[Calling Sirius Mods $functions\|callable]] $functions are used to save a $list to be later retrieved with the <var>[[$ListRst]]</var> function or the <var>[[$List_Global and $List_Session\|$List_Global]]</var> and <var>[[$List_Global and $List_Session\|$List_Session]]</var> functions. <var>$ListSav</var> and <var>$ListSave</var> are used with <var>$ListRst</var> or <var>$List_Global</var> to pass a $list between separate requests.

	==Syntax==		==Syntax==
	<p class="syntax">[%result =] $ListSav(list_identifier, [name])		<p class="syntax">[%result =] $ListSav(<span class="term">list_identifier</span>, [<span class="term">name</span>])

	[%result =] $ListSave(list_identifier, [name])		[%result =] $ListSave(<span class="term">list_identifier</span>, [<span class="term">name</span>])
	</p>		</p>

Line 27:		Line 27:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>A $list "saved" via <var>$ListSav</var> or <var>$ListSave</var> will be cleaned up at user logoff. After a $list has been "saved" via <var>$ListSav</var> or <var>$ListSave</var> it is no longer accessible in the current request, but will not be cleaned up at request termination or ~~RELEASE ALL RECORDS~~ processing. The $list is effectively "hidden" until restored via <var>$ListRst</var> or <var>$List_Global</var>.		<li>A $list "saved" via <var>$ListSav</var> or <var>$ListSave</var> will be cleaned up at user logoff. After a $list has been "saved" via <var>$ListSav</var> or <var>$ListSave</var> it is no longer accessible in the current request, but will not be cleaned up at request termination or <var>Release All Records</var> processing. The $list is effectively "hidden" until restored via <var>$ListRst</var> or <var>$List_Global</var>.

	<li>Only one $list can be saved at a time under a given name. For example:		<li>Only one $list can be saved at a time under a given name. For example:
Line 33:		Line 33:
	FOR %I FROM 1 TO 4		FOR %I FROM 1 TO 4
	%LIST1 = $ListNew		%LIST1 = $ListNew
	%RESULT = $ListAdd(%LIST1 , -		%RESULT = $ListAdd(%LIST1 , $WORD('HE SHE WE IT', , %I) WITH ' ATE')
	$WORD('HE SHE WE IT', , %I) WITH ' ATE')
	%RESULT = $ListSave(%LIST1, $WORD('A', , %I))		%RESULT = $ListSave(%LIST1, $WORD('A', , %I))
	END FOR		END FOR
Line 44:		Line 43:
	<li><code>HE ATE</code>, successfully saved via <var>$ListSave</var> under name <code>A</code>		<li><code>HE ATE</code>, successfully saved via <var>$ListSave</var> under name <code>A</code>
	<li><code>SHE ATE</code>, successfully saved via <var>$ListSave</var> under name ''		<li><code>SHE ATE</code>, successfully saved via <var>$ListSave</var> under name ''
	<li><code>IT ATE</code>, not saved, but accessible under $list identifier %~~result~~ for the duration of the request		<li><code>IT ATE</code>, not saved, but accessible under $list identifier <code>%RESULT</code> for the duration of the request
	</ol>		</ol>

	The string <code>WE ATE</code> is not saved (a list was already saved with the name ''), and since each invocation of <var>[[$ListNew]]</var> deletes the list associated with it, the list containing <code>WE ATE</code> was deleted in the last iteration of the <var>FOR</var> loop.		The string <code>WE ATE</code> is not saved (a list was already saved with the name ''), and since each invocation of <var>[[$ListNew]]</var> deletes the list associated with it, the list containing <code>WE ATE</code> was deleted in the last iteration of the <var>FOR</var> loop.

	<li>If <var>$ListSav</var> or <var>$ListSave</var> is invoked only with a null name argument, CCATEMP is not used and processing is very efficient. Because many Sirius Software products use $~~LISTSAV~~/$~~LISTRST~~ with the null global $list name, care should be taken of the interaction between global $list names used by your applications and the null $list name.		<li>If <var>$ListSav</var> or <var>$ListSave</var> is invoked only with a null name argument, CCATEMP is not used and processing is very efficient. Because many Sirius Software products use <var>$ListSav</var>/<var>$ListRst</var> with the null global $list name, care should be taken of the interaction between global $list names used by your applications and the null $list name.

	<li>To ensure that a <var>$ListSav</var> or <var>$ListSave</var> is not blocked by a previously "saved" list under a given name, you can simply issue a <var>$ListRst</var> to restore any previously saved list under that name, as in		<li>To ensure that a <var>$ListSav</var> or <var>$ListSave</var> is not blocked by a previously "saved" list under a given name, you can simply issue a <var>$ListRst</var> to restore any previously saved list under that name, as in
Line 59:		Line 58:
	Another way to address the problem of a global $list name already in use is to use the <var>$List_Global</var> function.		Another way to address the problem of a global $list name already in use is to use the <var>$List_Global</var> function.

	<li><var>$Lists</var> saved with <var>$ListSave</var> can also be accessed with <var>$List_Global</var>. For example,		<li><var>$Lists</var> saved with <var>$ListSave</var> can also be accessed with <var>$List_Global</var>. For example, this is a valid program:

	<p class="code">%result = $ListSave(%alist, 'MY.GLOBAL.LIST')		<p class="code">%result = $ListSave(%alist, 'MY.GLOBAL.LIST')
Line 65:		Line 64:
	</p>		</p>

	~~is a valid program.~~ While a name is accessed as a global, however, it is not possible to save another list to the same name. In		While a name is accessed as a global, however, it is not possible to save another list to the same name.
			This <var>$ListSave</var> would fail with a return code of -13:

	<p class="code"> %LIST = $List_Global('MY.GLOBAL.LIST')		<p class="code"> %LIST = $List_Global('MY.GLOBAL.LIST')
	%RESULT = $ListSave(%ALIST, 'MY.GLOBAL.LIST')		%RESULT = $ListSave(%ALIST, 'MY.GLOBAL.LIST')
	</p>		</p>
			It is possible to <var>$ListSave</var> a global $list to a separate name. In the following, the contents of global list <code>MY.GLOBAL.LIST</code> are saved under the name <code>OTHER.GLOBAL.LIST</code>:
	~~the <var>$ListSave</var> would fail with a return code of -13.~~ It is possible to <var>$ListSave</var> a global $list to a separate name. In

	<p class="code"> %LIST = $List_Global('MY.GLOBAL.LIST')		<p class="code"> %LIST = $List_Global('MY.GLOBAL.LIST')
Line 77:		Line 76:
	</p>		</p>

	~~the contents of global list MY.GLOBAL.LIST would be saved under the name OTHER.GLOBAL.LIST.~~ MY.GLOBAL.LIST would still be a valid global $list but would be empty.		<code>MY.GLOBAL.LIST</code> would still be a valid global $list, but it would be empty.

	<li>The only difference between <var>$ListSav</var> and <var>$ListSave</var> is that <var>$ListSav</var> will not allow the saving of an empty $list while <var>$ListSave</var> will and that <var>$ListSave</var> will replace an existing saved $list by the same name as long as the existing list is not active as a <var>$List_Global</var> list in the current procedure. For example, in		<li>The only difference between <var>$ListSav</var> and <var>$ListSave</var> is that <var>$ListSav</var> will not allow the saving of an empty $list while <var>$ListSave</var> will and that <var>$ListSave</var> will replace an existing saved $list by the same name as long as the existing list is not active as a <var>$List_Global</var> list in the current procedure. For example, in
Line 108:		Line 107:
	==Products authorizing $ListSav and $ListSave==		==Products authorizing $ListSav and $ListSave==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[~~List of $functions\|~~Sirius ~~functions~~]]</li>		<li>[[Sirius Functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>

JALWiccan: Automatically generated page update

2015-02-19T23:09:29Z

Automatically generated page update

← Older revision		Revision as of 23:09, 19 February 2015
Line 115:		Line 115:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>

	[[Category:$Functions\|$ListSav and $ListSave]]		[[Category:$Functions\|$ListSav and $ListSave]]

JALWiccan: Automatically generated page update

2015-02-19T22:58:21Z

Automatically generated page update

← Older revision		Revision as of 22:58, 19 February 2015
Line 115:		Line 115:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4b/~~SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>
	</ul>		</ul>

	[[Category:$Functions\|$ListSav and $ListSave]]		[[Category:$Functions\|$ListSav and $ListSave]]

JALWiccan: Automatically generated page update

2015-02-19T22:38:23Z

Automatically generated page update

← Older revision		Revision as of 22:38, 19 February 2015
Line 111:		Line 111:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[[Media:JosrvrNew.pdf\|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>

JALWiccan: Automatically generated page update

2015-02-19T22:34:56Z

Automatically generated page update

← Older revision		Revision as of 22:34, 19 February 2015
Line 111:		Line 111:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/1/17/~~JosrvrNew.pdf 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>

JALWiccan: Automatically generated page update

2015-02-19T21:21:20Z

Automatically generated page update

← Older revision		Revision as of 21:21, 19 February 2015
Line 110:		Line 110:
	<li>[[List of $functions\|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>[[Media:JoclrNew.pdf\|Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:17:41Z

Automatically generated page update

← Older revision		Revision as of 21:17, 19 February 2015
Line 110:		Line 110:
	<li>[[List of $functions\|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>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4a/~~JoclrNew.pdf Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

ELowell at 21:57, 11 November 2014

2014-11-11T21:57:29Z

← Older revision		Revision as of 21:57, 11 November 2014
Line 43:		Line 43:
	<ol>		<ol>
	<li><code>HE ATE</code>, successfully saved via <var>$ListSave</var> under name <code>A</code>		<li><code>HE ATE</code>, successfully saved via <var>$ListSave</var> under name <code>A</code>
	<li><code>SHE ATE</code>, successfully saved via <var>$ListSave</var> under name ''		<li><code>SHE ATE</code>, successfully saved via <var>$ListSave</var> under name ''
	<li><code>IT ATE</code>, not saved, but accessible under $list identifier %result for the duration of the request		<li><code>IT ATE</code>, not saved, but accessible under $list identifier %result for the duration of the request
	</ol>		</ol>

	The string <code>WE ATE</code> is not saved (a list was already saved with the name ''), and since each invocation of <var>[[$ListNew]]</var> deletes the list associated with it, the list containing <code>WE ATE</code> was deleted in the last iteration of the <var>FOR</var> loop.		The string <code>WE ATE</code> is not saved (a list was already saved with the name ''), and since each invocation of <var>[[$ListNew]]</var> deletes the list associated with it, the list containing <code>WE ATE</code> was deleted in the last iteration of the <var>FOR</var> loop.

	<li>If <var>$ListSav</var> or <var>$ListSave</var> is invoked only with a null name argument, CCATEMP is not used and processing is very efficient. Because many Sirius Software products use $LISTSAV/$LISTRST with the null global $list name, care should be taken of the interaction between global $list names used by your applications and the null $list name.		<li>If <var>$ListSav</var> or <var>$ListSave</var> is invoked only with a null name argument, CCATEMP is not used and processing is very efficient. Because many Sirius Software products use $LISTSAV/$LISTRST with the null global $list name, care should be taken of the interaction between global $list names used by your applications and the null $list name.

JALWiccan: Automatically generated page update

2014-08-01T22:08:02Z

Automatically generated page update

← Older revision		Revision as of 22:08, 1 August 2014
Line 108:		Line 108:
	==Products authorizing $ListSav and $ListSave==		==Products authorizing $ListSav and $ListSave==
	<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>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>		<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>