Compare (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (Formating and links) |
||
| Line 3: | Line 3: | ||
This method compares two <var>Stringlist</var>s and produces a <var>Stringlist</var> describing the differences between the two. | This method compares two <var>Stringlist</var>s and produces a <var>Stringlist</var> describing the differences between the two. | ||
The <var>Compare</var> method object, that is, the <var>Stringlist</var> against which <var>Compare</var> is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in sequential order. That is, the sequence number in each <var>Stringlist</var> item must be greater than the sequence number in the preceding item. | The <var>Compare</var> method object, that is, the <var>Stringlist</var> against which <var>Compare</var> is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in ascending, sequential order. That is, the sequence number in each <var>Stringlist</var> item must be greater than the sequence number in the preceding item. | ||
==Syntax== | ==Syntax== | ||
| Line 16: | Line 16: | ||
<td>The input <var>Stringlist</var>, which contains data that does not include 8-byte sequence numbers. This is a required argument.</td></tr> | <td>The input <var>Stringlist</var>, which contains data that does not include 8-byte sequence numbers. This is a required argument.</td></tr> | ||
<tr><th>synccount</th> | <tr><th>synccount</th> | ||
<td>A number indicating a synchronization count. When | <td>A number indicating a synchronization count. When <var>sl<var>, the method <var>Stringlist</var>, and the <var>inlist</var> <var>Stringlist</var> are being compared and a difference is found, <var>synccount</var> indicates the number of lines that must match before they are treated as a true match. This is an optional argument, and it defaults to 1.</td></tr> | ||
<tr><th>pad</th> | <tr><th>pad</th> | ||
<td>The pad character to be used to pad any input line that is too short. This is an optional argument, and it defaults to blank.</td></tr> | <td>The pad character to be used to pad any input line that is too short. This is an optional argument, and it defaults to blank.</td></tr> | ||
| Line 22: | Line 22: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors in <var>Compare</var> result in request cancellation.</ul> | <ul><li>All errors in <var>Compare</var> result in request cancellation.<li>The output <var>Stringlist</var> produced by <var>Compare</var> is in a format that is suitable as input to <var>[[Update (Stringlist function)|Update]]</var>.</ul> | ||
==Examples== | ==Examples== | ||
For example, assume the <var>Stringlist</var> object, identified by <tt>%objList</tt>, contains these items: | |||
<p class="code">00010000b | <p class="code">00010000b | ||
| Line 34: | Line 34: | ||
</p> | </p> | ||
And the input argument <var>Stringlist</var> contains these items: | And the input argument <var>Stringlist</var>, identified by <tt>%argList</tt>, contains these items: | ||
<p class="code">b | <p class="code">b | ||
| Line 49: | Line 49: | ||
</p> | </p> | ||
The result is the <var>Stringlist</var> identified by %outList, which contains: | The result is the <var>Stringlist</var>, identified by <tt>%outList</tt>, which contains: | ||
<p class="code">.li;./ I 00030000 $ 00030001 00010000 | <p class="code">.li;./ I 00030000 $ 00030001 00010000 | ||
| Line 55: | Line 55: | ||
</p> | </p> | ||
The method <var>Stringlist</var> for <var>Compare</var> (<tt> | The method <var>Stringlist</var> for <var>Compare</var> (<tt>%objlist</tt>, above) can be most easily created with <var>[[AppendOpenProcedure (Stringlist function)|AppendOpenProcedure]])</var>, using the third parameter to indicate a sequence number. | ||
[[Category:Stringlist methods|Compare function]] | [[Category:Stringlist methods|Compare function]] | ||
Revision as of 00:23, 26 January 2011
Compare two Stringlists and produce Stringlist describing differences (Stringlist class)
This method compares two Stringlists and produces a Stringlist describing the differences between the two.
The Compare method object, that is, the Stringlist against which Compare is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in ascending, sequential order. That is, the sequence number in each Stringlist item must be greater than the sequence number in the preceding item.
Syntax
[%outList =] sl:Compare( inList, [syncCount], [pad])
Syntax terms
| %outlist | A Stringlist to contain the result of the comparison of the method and input Stringlists. |
|---|---|
| sl | A Stringlist object. |
| inlist | The input Stringlist, which contains data that does not include 8-byte sequence numbers. This is a required argument. |
| synccount | A number indicating a synchronization count. When sl, the method Stringlist, and the inlist Stringlist are being compared and a difference is found, synccount indicates the number of lines that must match before they are treated as a true match. This is an optional argument, and it defaults to 1. |
| pad | The pad character to be used to pad any input line that is too short. This is an optional argument, and it defaults to blank. |
Usage notes
- All errors in Compare result in request cancellation.
- The output Stringlist produced by Compare is in a format that is suitable as input to Update.
Examples
For example, assume the Stringlist object, identified by %objList, contains these items:
00010000b 00020000 00030000print 'Quentin Compson' 00040000 00050000end
And the input argument Stringlist, identified by %argList, contains these items:
b print 'Quentin Compson' print 'Harvard Diving Team, 1908' end
This statement compares the Stringlists:
%outList = %objList:compare(%argList)
The result is the Stringlist, identified by %outList, which contains:
.li;./ I 00030000 $ 00030001 00010000 print 'Harvard Diving Team, 1908'
The method Stringlist for Compare (%objlist, above) can be most easily created with AppendOpenProcedure), using the third parameter to indicate a sequence number.