GetNextRecord (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (UL Interface becomes SOUL Interface) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 11: | Line 11: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%fastUnloadTaskState</th> | <tr><th>%fastUnloadTaskState</th> | ||
<td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the state of <var class="term">fastUnloadTask</var> after <var> | <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> | ||
<tr><th>fastUnloadTask</th> | <tr><th>fastUnloadTask</th> | ||
| Line 21: | Line 21: | ||
<li><var>GetNextRecord</var> can only be called when | <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. | <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. | If called in the <var>Done</var> state, the request is cancelled.</li> | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:FastUnloadTask:GetNextRecord footer}} | {{Template:FastUnloadTask:GetNextRecord footer}} | ||
[[Category:Fast/Unload | |||
[[Category:Fast/Unload SOUL Interface]] | |||
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.