RemoveItem (FloatNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (Undo revision 46505 by Dme (talk))
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Remove item from FloatNamedArrayli<section end=dpl_desc/></b></span>
{{Template:FloatNamedArraylist:RemoveItem subtitle}}
[[Category:FloatNamedArraylist methods|RemoveItem function]]
 
<!--DPL?? Category:FloatNamedArraylist methods|RemoveItem function: Remove item from FloatNamedArrayli-->
<var>RemoveItem</var> removes the item, that has the specified subscript number, from the <var>FloatNamedArraylist</var>.
<p>
RemoveItem is a member of the [[FloatNamedArraylist class]].
</p>


This callable function removes from the FloatNamedArraylist
the item that has the specified subscript number.
==Syntax==
==Syntax==
<p class="code">[%num =] %fnamrayl:RemoveItem(subscript)
{{Template:FloatNamedArraylist:RemoveItem syntax}}
</p>
===Syntax terms===
===Syntax Terms===
<table class="syntaxTable">
<dl>
<tr><th>%count</th>
<dt><i>%num</i>
<td>An, optional, numeric variable to contain the number of items remaining in the <var>FloatNamedArraylist</var> after the specified item is removed.</td></tr>
<dd>A numeric variable to contain the number of items in the FloatNamedArraylist
<tr><th>fltNal</th>
after the specified item is removed.
<td>A <var>FloatNamedArraylist</var> object.</td></tr>
<dt><i>%fnamrayl</i>
<tr><th>number</th>
<dd>A FloatNamedArraylist object.
<td>A numeric value that serves as a subscript to identify a <var class="term">fltNal</var> item.
<dt><i>subscript</i>
</td></tr>
<dd>A numeric value
</table>
that serves as a subscript to identify a ''%fnamrayl'' item.


If no item in ''%fnamrayl'' has the specified subscript,
==Usage Notes==
the request is cancelled,
<ul><li>If no item in <var class="term">fltNal</var> has the specified subscript, the request is cancelled, regardless of the setting of <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var>.</ul>
regardless of the setting of [[UseDefault (FloatNamedArraylist property)|UseDefault]].


</dl>
==See also==
{{Template:FloatNamedArraylist:RemoveItem footer}}

Latest revision as of 03:08, 8 August 2012

Remove item from FloatNamedArraylist (FloatNamedArraylist class)


RemoveItem removes the item, that has the specified subscript number, from the FloatNamedArraylist.

Syntax

[%count =] fltNal:RemoveItem( number)

Syntax terms

%count An, optional, numeric variable to contain the number of items remaining in the FloatNamedArraylist after the specified item is removed.
fltNal A FloatNamedArraylist object.
number A numeric value that serves as a subscript to identify a fltNal item.

Usage Notes

  • If no item in fltNal has the specified subscript, the request is cancelled, regardless of the setting of UseDefault.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RemoveItem_(FloatNamedArraylist_function)&oldid=15818"