GetNextRecord (FastUnloadTask function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
m (UL Interface becomes SOUL Interface)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:FastUnloadTask:GetNextRecord subtitle}}


<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
This [[Notation conventions for methods#Callable functions|callable]]
[[Category:FastUnloadTask methods|GetNextRecord function]]
method requests the next record from the <var class="product">[[Fast/Unload]]</var> task method object,
<p>
and it returns the new state of that <var>FastUnloadTask</var> object as a <var>[[FastUnloadTask class#The FastUnloadTaskState enumeration|FastUnloadTaskState]]</var> enumeration value.
<var>GetNextRecord</var> is a member of the <var>[[FastUnloadTask class|FastUnloadTask]]</var> class.
</p>


This [[Notation conventins for methods#Callable methods|callable]]
method requests the next record from the <var class="product">[[Fast/Unload]]</var> task method object,
and it returns the
new state of that <var>FastUnloadTask</var> object as a <var>FastUnloadTaskState</var> enumeration
value.
==Syntax==
==Syntax==
<p class="syntax">[%funtstate =] %funtask:GetNextRecord
{{Template:FastUnloadTask:GetNextRecord syntax}}
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%funtstate</th>
<tr><th>%fastUnloadTaskState</th>
<td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the state of ''%funtask'' after <var>[[FastUnloadTask (GetNextRecord function)|GetNextRecord]]</var> retrieves the record from ''%funtask''.
<td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the state of <var class="term">fastUnloadTask</var> after <var>GetNextRecord</var> retrieves the record from <var class="term">fastUnloadTask</var>.</td></tr>
</td></tr>
 
<tr><th>%funtask</th>
<tr><th>fastUnloadTask</th>
<td>An instantiated <var>FastUnloadTask</var> object variable.
<td>An instantiated <var>FastUnloadTask</var> object variable.</td></tr>
</table>


</td></tr></table>
==Usage notes==
<ul>
<li><var>GetNextRecord</var> can only be called when
<var class="term">fastUnloadTask</var> is in the <var>Started</var> or <var>HaveRecord</var> state.
If called in the <var>Done</var> state, the request is cancelled.</li>
</ul>


==Usage Notes==
==See also==
{{Template:FastUnloadTask:GetNextRecord footer}}


<var>GetNextRecord</var> can only be called when
[[Category:Fast/Unload SOUL Interface]]
''%funtask'' is in the <var>Started</var> or <var>HaveRecord</var> state.
If called in the <var>Done</var> state, the request is cancelled.

Latest revision as of 21:35, 16 March 2015

Get next record from Fast/Unload (FastUnloadTask class)


This callable method requests the next record from the Fast/Unload task method object, and it returns the new state of that FastUnloadTask object as a FastUnloadTaskState enumeration value.

Syntax

[%fastUnloadTaskState =] fastUnloadTask:GetNextRecord

Syntax terms

%fastUnloadTaskState A declared enumeration object of type FastUnloadTaskState to contain the state of fastUnloadTask after GetNextRecord retrieves the record from fastUnloadTask.
fastUnloadTask An instantiated FastUnloadTask object variable.

Usage notes

  • GetNextRecord can only be called when fastUnloadTask is in the Started or HaveRecord state. If called in the Done state, the request is cancelled.

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=GetNextRecord_(FastUnloadTask_function)&oldid=76579"