$List Diff Item: Difference between revisions
m (1 revision) |
(Automatically generated page update) |
||
| (39 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Differences between $list and delimited $list item</span> | <span class="pageSubtitle">Differences between $list and delimited $list item</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $List_Diff_Item function is <var>[[ItemDifferenceList (Stringlist function)|ItemDifferenceList]]</var>.</p> | ||
This function determines which items in a $list do not appear as an entry in a separator delimited item in a second $list and places them on a third $list. In some sense this is the "difference" between a $list and a separator delimited $list item. | This function determines which items in a $list do not appear as an entry in a separator delimited item in a second $list and places them on a third $list. In some sense this is the "difference" between a $list and a separator delimited $list item. | ||
$List_Diff_Item accepts five arguments and returns a numeric result. It is a | <var>$List_Diff_Item</var> accepts five arguments and returns a numeric result. It is a [[Calling Sirius Mods $functions|callable]] $function. | ||
The first argument is the identifier of a $list for which each item is to be compared against the delimited item in the second $list. This is a required argument. | The first argument is the identifier of a $list for which each item is to be compared against the delimited item in the second $list. This is a required argument. | ||
| Line 12: | Line 12: | ||
The second argument is the identifier of a $list containing the item containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument. | The second argument is the identifier of a $list containing the item containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument. | ||
The third argument is the identifier of a $list to contain any items from the first $list that do not appear as a delimiter separated entry in the indicated item from the second $list. The $list specified by the third argument is cleared before $List_Diff_Item does any processing. This is a required argument. | The third argument is the identifier of a $list to contain any items from the first $list that do not appear as a delimiter separated entry in the indicated item from the second $list. The $list specified by the third argument is cleared before <var>$List_Diff_Item</var> does any processing. This is a required argument. | ||
The fourth argument is the number of the item from the second $list containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument. | The fourth argument is the number of the item from the second $list containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument. | ||
| Line 20: | Line 20: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">[%RESULT =] $List_Diff_Item(list_id1, list_id2,- | ||
list_id3, list_item2, separator) | list_id3, list_item2, separator) | ||
</p> | </p> | ||
<p class=" | <p> | ||
</p> | |||
<p><var class="term">%result</var> is set to the number of items added to the output $list, or it is set to a negative error code if an error has occurred.</p> | |||
For an example of the use of this function, suppose $list %LIST1 contains six items: | For an example of the use of this function, suppose $list %LIST1 contains six items: | ||
| Line 103: | Line 103: | ||
<p class="code"> | <p class="code"> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<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>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[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> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
</p> | </p> | ||
<p | <p> | ||
</p> | </p> | ||
[[Category:$Functions|$List_Diff_Item]] | [[Category:$Functions|$List_Diff_Item]] | ||
Latest revision as of 22:51, 20 September 2018
Differences between $list and delimited $list item
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $List_Diff_Item function is ItemDifferenceList.
This function determines which items in a $list do not appear as an entry in a separator delimited item in a second $list and places them on a third $list. In some sense this is the "difference" between a $list and a separator delimited $list item.
$List_Diff_Item accepts five arguments and returns a numeric result. It is a callable $function.
The first argument is the identifier of a $list for which each item is to be compared against the delimited item in the second $list. This is a required argument.
The second argument is the identifier of a $list containing the item containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument.
The third argument is the identifier of a $list to contain any items from the first $list that do not appear as a delimiter separated entry in the indicated item from the second $list. The $list specified by the third argument is cleared before $List_Diff_Item does any processing. This is a required argument.
The fourth argument is the number of the item from the second $list containing a delimiter separated string that is to be scanned for each item from the first $list. This is a required argument.
The fifth argument is the delimiter character or characters to be used in the scanning the indicated $list item. It defaults to comma (,), and it cannot be the null string. Specifying this argument as a null string is the same as either not specifying the argument or specifying it as a comma.
Syntax
[%RESULT =] $List_Diff_Item(list_id1, list_id2,- list_id3, list_item2, separator)
%result is set to the number of items added to the output $list, or it is set to a negative error code if an error has occurred.
For an example of the use of this function, suppose $list %LIST1 contains six items:
BBB CC DDDD AAA E FFF
And $list %LIST2 contains two items:
X,Y,Z, AAA,DDDD,FFF,
Then this statement:
%CNT = $LIST_DIFF(%LIST1, %LIST2, %LIST3, 2)
results in %LIST3 having three items:
BBB CC E
%CNT is set to 3.
If a value occurs multiple times in the first input $list, it will appear either the same number of times in the output $list or not at all, depending on whether it appears in the separator- delimited item in the second $list.
For example, if $list %LIST1 contains eight items:
TCP/IP SNA CORBA MQSERIES SNA TCP/IP IPX TCP/IP
And $list %LIST2 contains three items:
Y2K**SECURITY**PRODUCTIVITY**METRICS** IND$FILE**LU6.2**SNA**MQSERIES**LU2** GIF**JPEG**WAV**PDF**HTML**
Then this statement:
%CNT = $List_Diff_Item(%LIST1, %LIST2, %LIST3, , '**')
Results in $list %LIST3 having five items:
TCP/IP CORBA TCP/IP IPX TCP/IP
%CNT is set to 5.
-3 - No room in CCATEMP -5 - Required argument not specified -6 - $List identifier invalid -7 - Invalid item number
$List_Diff_Item Error Codes
Products authorizing $List_Diff_Item
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility