Update (Stringlist function) - Revision history

Heikki: Change seq3 to seq2 for ./ R

2014-01-08T06:30:01Z

Change seq3 to seq2 for ./ R

← Older revision		Revision as of 06:30, 8 January 2014
Line 35:		Line 35:
	<td>This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. <var class="term">seq1</var> indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. <var class="term">seq2</var> is the sequence number to be assigned to the first inserted line, and <var class="term">seq3</var> indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.</td></tr>		<td>This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. <var class="term">seq1</var> indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. <var class="term">seq2</var> is the sequence number to be assigned to the first inserted line, and <var class="term">seq3</var> indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.</td></tr>

	<tr><th nowrap>./ R <var class="term">seq1</var> {<var class="term">~~seq3~~</var>} { $ <var class="term">seq3</var> { <var class="term">seq4</var> } }</th>		<tr><th nowrap>./ R <var class="term">seq1</var> {<var class="term">seq2</var>} { $ <var class="term">seq3</var> { <var class="term">seq4</var> } }</th>
	<td>This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be replaced. <var class="term">seq3</var> is the sequence number to be assigned to the first replacement line, and <var class="term">seq4</var> indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.</td></tr>		<td>This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be replaced. <var class="term">seq3</var> is the sequence number to be assigned to the first replacement line, and <var class="term">seq4</var> indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.</td></tr>

JAL: /* Usage notes */

2012-11-01T00:59:21Z

Usage notes

← Older revision		Revision as of 00:59, 1 November 2012
Line 18:		Line 18:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>Update</var> other than an invalid update item cause request cancellation.		<ul>
			<li>All errors in <var>Update</var> other than an invalid update item cause request cancellation.
	<li>The output <var>Stringlist</var> produced by <var>Update</var> contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to subsequent <var>Update</var> call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.		<li>The output <var>Stringlist</var> produced by <var>Update</var> contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to subsequent <var>Update</var> call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.
	<li>The method <var>Stringlist</var> for <var>Update</var> can be most easily created with <var>[[AppendOpenProcedure (Stringlist function)\|AppendOpenProcedure]]</var> using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to <var>Update</var> can be most easily created with <var>[[Compare (Stringlist function)\|Compare]]</var>.		<li>The method <var>Stringlist</var> for <var>Update</var> can be most easily created with <var>[[AppendOpenProcedure (Stringlist function)\|AppendOpenProcedure]]</var> using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to <var>Update</var> can be most easily created with <var>[[Compare (Stringlist function)\|Compare]]</var>.
	<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (<code>./</code>); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:		<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (<code>./</code>); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>.
	<dl><dt>./ * comment<dd>This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.		<p>
	<dt>./ D <var class="term">seq1</var> { <var class="term">seq2</var> } { $ }<dd>This is a deletion control statement that indicates a range of input lines to be deleted. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.		The update control statements are:</p>
	<dt>./ I <var class="term">seq1</var> { $ <var class="term">seq2</var> { <var class="term">seq3</var> } }<dd>This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. <var class="term">seq1</var> indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. <var class="term">seq2</var> is the sequence number to be assigned to the first inserted line, and <var class="term">seq3</var> indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.		<table>
	<dt>./ R <var class="term">seq1</var> {<var class="term">seq3</var>} { $ <var class="term">seq3</var> { <var class="term">seq4</var> } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be replaced. <var class="term">seq3</var> is the sequence number to be assigned to the first replacement line, and <var class="term">seq4</var> indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.		<tr><th>./ * comment</th>
	<dt>./ S <var class="term">seq1</var> { <var class="term">seq2</var> } { $ }<dd>This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at <var class="term">seq1</var> and incremented by <var class="term">seq2</var>.</dl>		<td>This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.</td></tr>

			<tr><th>./ D <var class="term">seq1</var> { <var class="term">seq2</var> } { $ }</th>
			<td>This is a deletion control statement that indicates a range of input lines to be deleted. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.</td></tr>

			<tr><th>./ I <var class="term">seq1</var> { $ <var class="term">seq2</var> { <var class="term">seq3</var> } }</th>
			<td>This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. <var class="term">seq1</var> indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. <var class="term">seq2</var> is the sequence number to be assigned to the first inserted line, and <var class="term">seq3</var> indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.</td></tr>

			<tr><th nowrap>./ R <var class="term">seq1</var> {<var class="term">seq3</var>} { $ <var class="term">seq3</var> { <var class="term">seq4</var> } }</th>
			<td>This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be replaced. <var class="term">seq3</var> is the sequence number to be assigned to the first replacement line, and <var class="term">seq4</var> indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.</td></tr>

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

	==See also==		==See also==
	{{Template:Stringlist:Update footer}}		{{Template:Stringlist:Update footer}}

Goff: syntax diagram, tags and links

2011-01-28T01:04:12Z

syntax diagram, tags and links

← Older revision		Revision as of 01:04, 28 January 2011
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~outlist~~</th>		<tr><th>%outList</th>
	<td>The output <var>Stringlist</var>.</td></tr>		<td>The output <var>Stringlist</var>.</td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A <var>Stringlist</var> object that must contain items with 8-byte sequence numbers.</td></tr>		<td>A <var>Stringlist</var> object that must contain items with 8-byte sequence numbers.</td></tr>
	<tr><th>~~updlist~~</th>		<tr><th>updList</th>
	<td>A <var>Stringlist</var> that contains update control statements and insertion or replacement lines.</td></tr>		<td>A <var>Stringlist</var> that contains update control statements and insertion or replacement lines.</td></tr>
	<tr><th>status</th>		<tr><th>%status</th>
	<td>A numeric variable that is set to 0 if the method is successful, or it is set to the item number of the invalid update command if ~~'''updlist'''~~ contains an invalid item. This is an optional output argument.</td></tr>		<td>A numeric variable that is set to 0 if the method is successful, or it is set to the item number of the invalid update command if <var class="term">updList</var> contains an invalid item. This is an optional output argument.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>Update</var> other than an invalid update item cause request cancellation.<li>The output <var>Stringlist</var> produced by <var>Update</var> contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to ~~another~~ <var>Update</var> call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.<li>The method <var>Stringlist</var> for <var>Update</var> can be most easily created with ~~the~~ AppendOpenProcedure ~~method~~ (~~:hdref reftxt=~~AppendOpenProcedure ~~refid=appopen.)~~ using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to <var>Update</var> can be most easily created with ~~the~~ Compare ~~method~~ (~~:hdref reftxt=~~Compare ~~refid=slcomp.)~~.<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (./); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:<dl>		<ul><li>All errors in <var>Update</var> other than an invalid update item cause request cancellation.
	<dt>./ * comment<dd> This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ D seq1 { seq2 } { $ }<dd> This is a deletion control statement that indicates a range of input lines to be deleted. ~~'''~~seq1~~'''~~ and ~~'''~~seq2~~'''~~ indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If ~~'''~~seq2~~'''~~ is not specified, it is assumed to equal ~~'''~~seq1~~'''~~, so only the single line indicated by ~~'''~~seq1~~'''~~ will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ I seq1 { $ seq2 { seq3 } }<dd> This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. ~~'''~~seq1~~'''~~ indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. ~~'''~~seq2~~'''~~ is the sequence number to be assigned to the first inserted line, and ~~'''~~seq3~~'''~~ indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.<dt>./ R seq1 {~~seq2~~} { $ seq3 { seq4 } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. ~~'''~~seq1~~'''~~ and ~~'''~~seq2~~'''~~ indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If ~~'''~~seq2~~'''~~ is not specified, it is assumed to equal ~~'''~~seq1~~'''~~, so only the single line indicated by ~~'''~~seq1~~'''~~ will be replaced. ~~'''~~seq3~~'''~~ is the sequence number to be assigned to the first replacement line, and ~~'''~~seq4~~'''~~ indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.<dt>./ S seq1 { seq2 } { $ }<dd> This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at ~~'''~~seq1~~'''~~ and incremented by ~~'''~~seq2~~'''~~.</dl>		<li>The output <var>Stringlist</var> produced by <var>Update</var> contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to subsequent <var>Update</var> call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.
			<li>The method <var>Stringlist</var> for <var>Update</var> can be most easily created with <var>[[AppendOpenProcedure (Stringlist function)\|AppendOpenProcedure]]</var> using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to <var>Update</var> can be most easily created with <var>[[Compare (Stringlist function)\|Compare]]</var>.
			<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (<code>./</code>); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:
			<dl><dt>./ * comment<dd>This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.
			<dt>./ D <var class="term">seq1</var> { <var class="term">seq2</var> } { $ }<dd>This is a deletion control statement that indicates a range of input lines to be deleted. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.
			<dt>./ I <var class="term">seq1</var> { $ <var class="term">seq2</var> { <var class="term">seq3</var> } }<dd>This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. <var class="term">seq1</var> indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. <var class="term">seq2</var> is the sequence number to be assigned to the first inserted line, and <var class="term">seq3</var> indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.
			<dt>./ R <var class="term">seq1</var> {<var class="term">seq3</var>} { $ <var class="term">seq3</var> { <var class="term">seq4</var> } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. <var class="term">seq1</var> and <var class="term">seq2</var> indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If <var class="term">seq2</var> is not specified, it is assumed to equal <var class="term">seq1</var>, so only the single line indicated by <var class="term">seq1</var> will be replaced. <var class="term">seq3</var> is the sequence number to be assigned to the first replacement line, and <var class="term">seq4</var> indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.
			<dt>./ S <var class="term">seq1</var> { <var class="term">seq2</var> } { $ }<dd>This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at <var class="term">seq1</var> and incremented by <var class="term">seq2</var>.</dl>
	</ul>		</ul>

	==See also==		==See also==
	{{Template:Stringlist:Update footer}}		{{Template:Stringlist:Update footer}}

Wiccan: 1 revision

2011-01-26T18:56:25Z

1 revision

← Older revision	Revision as of 18:56, 26 January 2011
(No difference)

Wiccan: 1 revision

2011-01-26T18:56:18Z

1 revision

← Older revision		Revision as of 18:56, 26 January 2011
Line 22:		Line 22:
	</ul>		</ul>

	~~[[Category~~:Stringlist ~~methods\|~~Update ~~function]]~~		==See also==
			{{Template:Stringlist:Update footer}}

Wiccan: 1 revision

2011-01-19T16:12:33Z

1 revision

← Older revision	Revision as of 16:12, 19 January 2011
(No difference)

Wiccan: 1 revision

2011-01-19T16:12:29Z

1 revision

← Older revision		Revision as of 16:12, 19 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:Update subtitle}}		{{Template:Stringlist:Update subtitle}}

	This method uses an input <var>Stringlist</var> to update the method <var>Stringlist</var>, producing an output <var>Stringlist</var> that contains data from the method <var>Stringlist</var> as modified by the first argument <var>Stringlist</var>. The Update method accepts two arguments and returns a <var>Stringlist</var>. The method <var>Stringlist</var> must contain items with 8-byte sequence numbers.		This method uses an input <var>Stringlist</var> to update the method <var>Stringlist</var>, producing an output <var>Stringlist</var> that contains data from the method <var>Stringlist</var> as modified by the first argument <var>Stringlist</var>. The <var>Update</var> method accepts two arguments and returns a <var>Stringlist</var>. The method <var>Stringlist</var> must contain items with 8-byte sequence numbers.

	==Syntax==		==Syntax==
Line 18:		Line 18:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in Update other than an invalid update item cause request cancellation.<li>The output <var>Stringlist</var> produced by Update contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to another Update call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.<li>The method <var>Stringlist</var> for Update can be most easily created with the AppendOpenProcedure method (:hdref reftxt=AppendOpenProcedure refid=appopen.) using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to Update can be most easily created with the Compare method (:hdref reftxt=Compare refid=slcomp.).<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (./); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:<dl>		<ul><li>All errors in <var>Update</var> other than an invalid update item cause request cancellation.<li>The output <var>Stringlist</var> produced by <var>Update</var> contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to another <var>Update</var> call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.<li>The method <var>Stringlist</var> for <var>Update</var> can be most easily created with the AppendOpenProcedure method (:hdref reftxt=AppendOpenProcedure refid=appopen.) using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to <var>Update</var> can be most easily created with the Compare method (:hdref reftxt=Compare refid=slcomp.).<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (./); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:<dl>
	<dt>./ * comment<dd> This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ D seq1 { seq2 } { $ }<dd> This is a deletion control statement that indicates a range of input lines to be deleted. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ I seq1 { $ seq2 { seq3 } }<dd> This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. '''seq1''' indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. '''seq2''' is the sequence number to be assigned to the first inserted line, and '''seq3''' indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.<dt>./ R seq1 {seq2} { $ seq3 { seq4 } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be replaced. '''seq3''' is the sequence number to be assigned to the first replacement line, and '''seq4''' indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.<dt>./ S seq1 { seq2 } { $ }<dd> This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.</dl>		<dt>./ * comment<dd> This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ D seq1 { seq2 } { $ }<dd> This is a deletion control statement that indicates a range of input lines to be deleted. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ I seq1 { $ seq2 { seq3 } }<dd> This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. '''seq1''' indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. '''seq2''' is the sequence number to be assigned to the first inserted line, and '''seq3''' indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.<dt>./ R seq1 {seq2} { $ seq3 { seq4 } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be replaced. '''seq3''' is the sequence number to be assigned to the first replacement line, and '''seq4''' indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.<dt>./ S seq1 { seq2 } { $ }<dd> This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.</dl>
	</ul>		</ul>

	[[Category:Stringlist methods\|Update function]]		[[Category:Stringlist methods\|Update function]]

Wiccan: 1 revision

2011-01-18T21:33:45Z

1 revision

← Older revision	Revision as of 21:33, 18 January 2011
(No difference)

Wiccan: 1 revision

2011-01-18T21:33:38Z

1 revision

← Older revision		Revision as of 21:33, 18 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:Update subtitle}}		{{Template:Stringlist:Update subtitle}}

	This method uses an input Stringlist to update the method Stringlist, producing an output Stringlist that contains data from the method Stringlist as modified by the first argument Stringlist. The Update method accepts two arguments and returns a Stringlist. The method Stringlist must contain items with 8-byte sequence numbers.		This method uses an input <var>Stringlist</var> to update the method <var>Stringlist</var>, producing an output <var>Stringlist</var> that contains data from the method <var>Stringlist</var> as modified by the first argument <var>Stringlist</var>. The Update method accepts two arguments and returns a <var>Stringlist</var>. The method <var>Stringlist</var> must contain items with 8-byte sequence numbers.

	==Syntax==		==Syntax==
Line 8:		Line 8:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outlist</th>		<tr><th>%outlist</th>
	<td>The output Stringlist.</td></tr>		<td>The output <var>Stringlist</var>.</td></tr>
	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A Stringlist object that must contain items with 8-byte sequence numbers.</td></tr>		<td>A <var>Stringlist</var> object that must contain items with 8-byte sequence numbers.</td></tr>
	<tr><th>updlist</th>		<tr><th>updlist</th>
	<td>A Stringlist that contains update control statements and insertion or replacement lines.</td></tr>		<td>A <var>Stringlist</var> that contains update control statements and insertion or replacement lines.</td></tr>
	<tr><th>status</th>		<tr><th>status</th>
	<td>A numeric variable that is set to 0 if the method is successful, or it is set to the item number of the invalid update command if '''updlist''' contains an invalid item. This is an optional output argument.</td></tr>		<td>A numeric variable that is set to 0 if the method is successful, or it is set to the item number of the invalid update command if '''updlist''' contains an invalid item. This is an optional output argument.</td></tr>
Line 18:		Line 18:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in Update other than an invalid update item cause request cancellation.<li>The output Stringlist produced by Update contains sequence numbers just as the input Stringlist in the first argument. This makes it possible to use the output Stringlist as input to another Update call. In this way it is possible to apply multiple updates to a single Stringlist.<li>The method Stringlist for Update can be most easily created with the AppendOpenProcedure method (:hdref reftxt=AppendOpenProcedure refid=appopen.) using its fourth parameter to indicate a sequence number. The input argument Stringlist to Update can be most easily created with the Compare method (:hdref reftxt=Compare refid=slcomp.).<li>The update Stringlist contains update control statements and insertion or replacement lines. The update Stringlist must begin with an update control statement. All update control statements begin with the period-slash character sequence (./); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input Stringlist to which the updates apply. Any items in the method Stringlist that are not updated by the update Stringlist are simply copied into the output Stringlist. The update control statements are:<dl>		<ul><li>All errors in Update other than an invalid update item cause request cancellation.<li>The output <var>Stringlist</var> produced by Update contains sequence numbers just as the input <var>Stringlist</var> in the first argument. This makes it possible to use the output <var>Stringlist</var> as input to another Update call. In this way it is possible to apply multiple updates to a single <var>Stringlist</var>.<li>The method <var>Stringlist</var> for Update can be most easily created with the AppendOpenProcedure method (:hdref reftxt=AppendOpenProcedure refid=appopen.) using its fourth parameter to indicate a sequence number. The input argument <var>Stringlist</var> to Update can be most easily created with the Compare method (:hdref reftxt=Compare refid=slcomp.).<li>The update <var>Stringlist</var> contains update control statements and insertion or replacement lines. The update <var>Stringlist</var> must begin with an update control statement. All update control statements begin with the period-slash character sequence (./); this is followed by a single character indicating the function, and then possibly by sequence numbers indicating the lines in the input <var>Stringlist</var> to which the updates apply. Any items in the method <var>Stringlist</var> that are not updated by the update <var>Stringlist</var> are simply copied into the output <var>Stringlist</var>. The update control statements are:<dl>
	<dt>./ * comment<dd> This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update Stringlist.<dt>./ D seq1 { seq2 } { $ }<dd> This is a deletion control statement that indicates a range of input lines to be deleted. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the method Stringlist that are to be deleted. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update Stringlist.<dt>./ I seq1 { $ seq2 { seq3 } }<dd> This is an insertion control statement, and it is followed by lines that are to be inserted in the output Stringlist. '''seq1''' indicates the sequence number in the method Stringlist after which the lines are to be inserted. '''seq2''' is the sequence number to be assigned to the first inserted line, and '''seq3''' indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.<dt>./ R seq1 {seq2} { $ seq3 { seq4 } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method Stringlist in the output Stringlist. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the input Stringlist that are to be replaced. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be replaced. '''seq3''' is the sequence number to be assigned to the first replacement line, and '''seq4''' indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.<dt>./ S seq1 { seq2 } { $ }<dd> This is a resequence control statement, and it must be the first non-comment control statement in the update Stringlist. This statement indicates that the output Stringlist, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.</dl>		<dt>./ * comment<dd> This is a comment control statement and it is ignored. It must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ D seq1 { seq2 } { $ }<dd> This is a deletion control statement that indicates a range of input lines to be deleted. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the method <var>Stringlist</var> that are to be deleted. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be deleted. This statement must be followed by another update control statement, or it must be the last item in the update <var>Stringlist</var>.<dt>./ I seq1 { $ seq2 { seq3 } }<dd> This is an insertion control statement, and it is followed by lines that are to be inserted in the output <var>Stringlist</var>. '''seq1''' indicates the sequence number in the method <var>Stringlist</var> after which the lines are to be inserted. '''seq2''' is the sequence number to be assigned to the first inserted line, and '''seq3''' indicates the increment to be added to the current sequence number for subsequent inserted lines. The lines to be inserted are terminated by another update control statement.<dt>./ R seq1 {seq2} { $ seq3 { seq4 } }<dd> This is a replacement control statement, and it is followed by lines that are to replace lines from the method <var>Stringlist</var> in the output <var>Stringlist</var>. '''seq1''' and '''seq2''' indicate the range of sequence numbers in the input <var>Stringlist</var> that are to be replaced. If '''seq2''' is not specified, it is assumed to equal '''seq1''', so only the single line indicated by '''seq1''' will be replaced. '''seq3''' is the sequence number to be assigned to the first replacement line, and '''seq4''' indicates the increment to be added to the current sequence number for subsequent replacement lines. The replacement lines are terminated by another update control statement.<dt>./ S seq1 { seq2 } { $ }<dd> This is a resequence control statement, and it must be the first non-comment control statement in the update <var>Stringlist</var>. This statement indicates that the output <var>Stringlist</var>, after all subsequent updates have been applied, is to be given sequence numbers starting at '''seq1''' and incremented by '''seq2'''.</dl>
	</ul>		</ul>

	[[Category:Stringlist methods\|Update function]]		[[Category:Stringlist methods\|Update function]]

Wiccan: 1 revision

2011-01-17T21:07:33Z

1 revision

← Older revision	Revision as of 21:07, 17 January 2011
(No difference)