$ListUpd - Revision history

JALWiccan: Automatically generated page update

2018-09-20T22:51:57Z

Automatically generated page update

← Older revision		Revision as of 22:51, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>		<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is <var>[[Update (Stringlist function)\|Update]]</var>.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is <var>[[Update (Stringlist function)\|Update]]</var>.</p>

	This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.		This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.

JALWiccan: Automatically generated page update

2013-07-19T18:44:59Z

Automatically generated page update

← Older revision		Revision as of 18:44, 19 July 2013
Line 18:		Line 18:
	</p>		</p>

	<p>%result is set either to the number of items in the output $list, or to a negative error code if an error has occurred.</p>		<p><var class="term">%result</var> is set either to the number of items in the output $list, or to a negative error code if an error has occurred.</p>

	===Error codes===		===Error codes===

JAL at 23:46, 18 July 2013

2013-07-18T23:46:57Z

← Older revision		Revision as of 23:46, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>		<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>

	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is ~~the~~ [[Update (Stringlist function)]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is <var>[[Update (Stringlist function)\|Update]]</var>.</p>

	This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.		This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.
Line 17:		Line 17:
	<p class="syntax">[%RESULT =] $ListUpd(list_id1, list_id2, list_id3)		<p class="syntax">[%RESULT =] $ListUpd(list_id1, list_id2, list_id3)
	</p>		</p>
	~~<p>~~
	~~</p>~~
	<p>%result is set either to the number of items in the output $list, or to a negative error code if an error has occurred.</p>		<p>%result is set either to the number of items in the output $list, or to a negative error code if an error has occurred.</p>

	~~The output~~ $list ~~produced by~~ <var>$~~ListUpd~~</var> ~~contains sequence numbers just as input~~ $list 1~~. This makes it possible to use the output $list as input to another <var>$ListUpd~~</~~var~~> ~~call. In this way it is possible to apply multiple updates to a single $list.~~		===Error codes===
			<p class="code">-3 - No room to create $list items
			(if LISTFC <var>$SirParm</var> parameter not set)
			-5 - Required argument not specified
			-6 - $List identifier invalid
			-8 - Input $list 1 has invalid format
			</p>

	The ~~first input~~ $list to <var>$ListUpd</var> ~~can be most easily created with the <var>~~$~~ProcDat</var> function using~~ the ~~fifth parameter to indicate a sequence number. The second input~~ $list to <var>$ListUpd</var> ~~can be most easily created with the <var>~~$~~ListCmp</var> function~~.		==Usage notes==
			<ul>
			<li>The output $list produced by <var>$ListUpd</var> contains sequence numbers just as input $list 1. This makes it possible to use the output $list as input to another <var>$ListUpd</var> call. In this way it is possible to apply multiple updates to a single $list.

	<~~p class="code"~~>		<li>The first input $list to <var>$ListUpd</var> can be most easily created with the <var>$ProcDat</var> function using the fifth parameter to indicate a sequence number. The second input $list to <var>$ListUpd</var> can be most easily created with the <var>$ListCmp</var> function.
	~~-3 - No room~~ to ~~create~~ $~~list items~~
	~~(if LISTFC~~ <var>$~~SirParm~~</var> parameter ~~not set)~~
	~~-5 - Required argument not specified~~
	~~-6 -~~ $~~List identifier invalid~~
	~~-8 - Input~~ $~~list 1 has invalid format~~
	</p>
	<~~p class="caption"~~>$~~ListUpd Error Codes~~
	</p>

	The update $list (input $list 2) contains update control statements and insertion or replacement lines. The update $list must begin with an update control statement. All update control statements begin with the './ ' characters followed by a single character indicating the function and possible sequence numbers indicating the lines in input $list to which the updates apply. Any items in input $list 1 not updated by the update $list are simply copied into the output $list. The update control statements are:		<li>The update $list (input $list 2) contains update control statements and insertion or replacement lines. The update $list must begin with an update control statement. All update control statements begin with the './ ' characters followed by a single character indicating the function and possible sequence numbers indicating the lines in input $list to which the updates apply. Any items in input $list 1 not updated by the update $list are simply copied into the output $list. The update control statements are:

	<table class="syntaxTable">		<table class="syntaxTable">
Line 48:		Line 47:
	<tr><th>./ S seq1 { seq2 } { $ }</th>		<tr><th>./ S seq1 { seq2 } { $ }</th>
	<td> This is an resequence control statement and must be the first non-comment control statement in the update $list. This statement indicates that the output $list, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.		<td> This is an resequence control statement and must be the first non-comment control statement in the update $list. This statement indicates that the output $list, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.
	</td></tr></table>		</td></tr>
			</table>
			</ul>

	~~<p class="code">~~
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
Line 56:		Line 56:
	</ul>		</ul>

	~~</p>~~
	~~<p>~~
	~~</p>~~

	[[Category:$Functions\|$ListUpd]]		[[Category:$Functions\|$ListUpd]]

JALWiccan: Automatically generated page update

2013-07-18T20:54:31Z

Automatically generated page update

← Older revision		Revision as of 20:54, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>		<span class="pageSubtitle">Produce $list from input $list using $list of updates</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is the [[Update (Stringlist function)]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListUpd function is the [[Update (Stringlist function)]].</p>

	This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.		This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.

JALWiccan: Automatically generated page update

2013-04-10T18:17:15Z

Automatically generated page update

← Older revision		Revision as of 18:17, 10 April 2013
Line 15:		Line 15:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>[%RESULT =] $ListUpd(list_id1, list_id2, list_id3)		<p class="syntax">[%RESULT =] $ListUpd(list_id1, list_id2, list_id3)
	~~<section end="syntax" />~~</p>		</p>
	<p>		<p>
	</p>		</p>

DmeWiccan: 1 revision

2012-11-07T21:32:50Z

1 revision

← Older revision	Revision as of 21:32, 7 November 2012
(No difference)

JALWiccan: 1 revision

2012-11-07T21:32:39Z

1 revision

← Older revision		Revision as of 21:32, 7 November 2012
Line 51:		Line 51:

	<p class="code">		<p class="code">
	~~<h2>~~Products authorizing {{PAGENAMEE}}~~</h2>~~<ul class="smallAndTightList">		==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
	<li>[[SirLib]]		<li>[[SirLib]]
	</ul>		</ul>

JALWiccan: 1 revision

2012-10-26T01:29:29Z

1 revision

← Older revision	Revision as of 01:29, 26 October 2012
(No difference)

JALWiccan: 1 revision

2012-10-26T01:29:26Z

1 revision

← Older revision		Revision as of 01:29, 26 October 2012
Line 6:		Line 6:
	This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.		This function uses a first $list to update a second $list, producing a third $list containing data from the second $list as modified by the first $list.

	The <var>$ListUpd</var> function accepts three arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function ~~(see [[Calling Sirius Mods $functions]])~~.		The <var>$ListUpd</var> function accepts three arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions\|callable]] $function.

	The first argument is the identifier of a $list containing data with 8 byte sequence numbers. This is a required argument.		The first argument is the identifier of a $list containing data with 8 byte sequence numbers. This is a required argument.

JALWiccan: 1 revision

2012-10-26T01:20:56Z

1 revision

← Older revision	Revision as of 01:20, 26 October 2012
(No difference)