ItemDifferenceList (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (syntax digram, tags and links)
Line 1: Line 1:
{{Template:Stringlist:ItemDifferenceList subtitle}}
{{Template:Stringlist:ItemDifferenceList subtitle}}


This method determines which items in a <var>Stringlist</var> do not appear as an entry in a separator-delimited item in a second <var>Stringlist</var>, and it places them on an output <var>Stringlist</var>. In some sense, the output <var>Stringlist</var> is the "difference" between a <var>Stringlist</var> and a separator-delimited <var>Stringlist</var> item.
This method determines which items in a <var>stringlist</var> do not appear as an entry in a separator-delimited item in a second <var>stringlist</var>, and it places them on an output <var>stringlist</var>. In some sense, the output <var>stringlist</var> is the "difference" between a <var>stringlist</var> and a separator-delimited <var>stringlist</var> item.


==Syntax==
==Syntax==
Line 8: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outlist</th>
<tr><th>%outlist</th>
<td>This <var>Stringlist</var> contains the items from '''%sl''' that do not appear in the specified item in '''sl1'''. </td></tr>
<td>This <var>stringlist</var> contains the items from <var class="term">sl</var> that do not appear in the specified item in <var class="term">sl1</var>. </td></tr>
<tr><th>sl</th>
<tr><th>sl</th>
<td>A <var>Stringlist</var> object. </td></tr>
<td>A <var>stringlist</var> object. </td></tr>
<tr><th>sl1</th>
<tr><th>sl1</th>
<td>The identifier of a <var>Stringlist</var> that contains the item that contains a delimiter-separated string that is to be scanned for each item from the method <var>Stringlist</var>, '''%sl'''. </td></tr>
<td>The identifier of a <var>Stringlist</var> containing the item that is a delimiter-separated string to be scanned for each item from the method <var>stringlist</var>, <var class="term">sl</var>. </td></tr>
<tr><th>itemnum</th>
<tr><th>itemnum</th>
<td>The number of the item from '''%sl1''' that contains a delimiter-separated string that is to be scanned for each item from '''%sl'''. Each '''%sl''' item that does not appear in the delimiter-separated string becomes an item in the resultant <var>Stringlist</var>, '''%outlist'''. </td></tr>
<td>The number of the item from <var class="term">sl1</var> that is a delimiter-separated string to be scanned for each item from <var class="term">sl</var>. Each <var class="term">sl</var> item that does not appear in the delimiter-separated string becomes an item in the resultant <var>stringlist</var>, <var class="term">%outlist</var>. </td></tr>
<tr><th>separator</th>
<tr><th>separator</th>
<td>The delimiter character or characters to be used in the scanning of the indicated <var>Stringlist</var> item. This optional argument defaults to comma (<tt>.,</tt>), and it cannot be the null string. Specifying '''separator''' as a null string is the same as not specifying the argument or as specifying it as a comma.</td></tr>
<td>The delimiter character, or characters, to be used in the scanning of the indicated <var>stringlist</var> item. This optional argument defaults to comma (<var class="term">','</var>), and cannot be the null string. Specifying <var class="term">separator</var> as a null string is the same as not specifying the argument or as specifying it as a comma.</td></tr>
</table>
</table>


Line 26: Line 26:
==Examples==
==Examples==
<ol>
<ol>
<li>As an example of the use of this method, suppose <var>Stringlist</var> %list1 contained these six items:
<li>As an example of the use of this method, suppose <var>Stringlist</var> <var class="term">%list1</var> contained these six items:


<p class="code">BBB
<p class="code">BBB
Line 36: Line 36:
</p>
</p>


Suppose <var>Stringlist</var> %list2 contained two items:
Suppose <var>Stringlist</var> <var class="term">%list2</var> contained two items:


<p class="code">X,Y,Z,
<p class="code">X,Y,Z,
Line 47: Line 47:
</p>
</p>


The resulting %list3 has three items:
The resulting <var class="term">%list3</var> has three items:


<p class="code">BBB
<p class="code">BBB
Line 56: Line 56:
<li>If a value occurs multiple times in the first object <var>Stringlist</var>, it will appear the same number of times in the output <var>Stringlist</var> or not at all, depending on whether it appears in the separator-delimited item in the first argument <var>Stringlist</var>.
<li>If a value occurs multiple times in the first object <var>Stringlist</var>, it will appear the same number of times in the output <var>Stringlist</var> or not at all, depending on whether it appears in the separator-delimited item in the first argument <var>Stringlist</var>.


For example, if <var>Stringlist</var> %list1 contained these eight items:
For example, if <var>Stringlist</var> <var class="term">%list1</var> contained these eight items:


<p class="code">TCP/IP
<p class="code">TCP/IP
Line 68: Line 68:
</p>
</p>


And if <var>Stringlist</var> %list2 contained these three items:
And if <var>Stringlist</var> <var class="term">%list2</var> contained these three items:


<p class="code">Y2K**SECURITY**PRODUCTIVITY**METRICS**
<p class="code">Y2K**SECURITY**PRODUCTIVITY**METRICS**
Line 80: Line 80:
</p>
</p>


The resulting <var>Stringlist</var> %list3 has five items:
The resulting <var>Stringlist</var> <var class="term">%list3</var> has five items:


<p class="code">TCP/IP
<p class="code">TCP/IP

Revision as of 06:37, 26 January 2011

Compare Stringlist to delimited Stringlist item (Stringlist class)


This method determines which items in a stringlist do not appear as an entry in a separator-delimited item in a second stringlist, and it places them on an output stringlist. In some sense, the output stringlist is the "difference" between a stringlist and a separator-delimited stringlist item.

Syntax

%outList = sl:ItemDifferenceList( sl1, itemNum, [separator])

Syntax terms

%outlist This stringlist contains the items from sl that do not appear in the specified item in sl1.
sl A stringlist object.
sl1 The identifier of a Stringlist containing the item that is a delimiter-separated string to be scanned for each item from the method stringlist, sl.
itemnum The number of the item from sl1 that is a delimiter-separated string to be scanned for each item from sl. Each sl item that does not appear in the delimiter-separated string becomes an item in the resultant stringlist, %outlist.
separator The delimiter character, or characters, to be used in the scanning of the indicated stringlist item. This optional argument defaults to comma (','), and cannot be the null string. Specifying separator as a null string is the same as not specifying the argument or as specifying it as a comma.

Usage notes

  • All errors in ItemDifferenceList result in request cancellation.

Examples

  1. As an example of the use of this method, suppose Stringlist %list1 contained these six items:

    BBB CC DDDD AAA E FFF

    Suppose Stringlist %list2 contained two items:

    X,Y,Z, AAA,DDDD,FFF,

    If this is the ItemDifferenceList invocation:

    %list3 = %list1:itemDifferenceList(%list2, 2)

    The resulting %list3 has three items:

    BBB CC E

  2. If a value occurs multiple times in the first object Stringlist, it will appear the same number of times in the output Stringlist or not at all, depending on whether it appears in the separator-delimited item in the first argument Stringlist. For example, if Stringlist %list1 contained these eight items:

    TCP/IP SNA CORBA MQSERIES SNA TCP/IP IPX TCP/IP

    And if Stringlist %list2 contained these three items:

    Y2K**SECURITY**PRODUCTIVITY**METRICS** IND$FILE**LU6.2**SNA**MQSERIES**LU2** GIF**JPEG**WAV**PDF**HTML**

    And if this is the ItemDifferenceList invocation:

    %list3 = %list1:itemDifferenceList(%list2, '++')

    The resulting Stringlist %list3 has five items:

    TCP/IP CORBA TCP/IP IPX TCP/IP

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=ItemDifferenceList_(Stringlist_function)&oldid=8201"