GetNextRecord (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:FastUnloadTask:GetNextRecord subtitle}} | {{Template:FastUnloadTask:GetNextRecord subtitle}} | ||
This [[Notation | This [[Notation conventions for methods#Callable methods|callable]] | ||
method requests the next record from the <var class="product">[[Fast/Unload]]</var> task method object, | method requests the next record from the <var class="product">[[Fast/Unload]]</var> task method object, | ||
and it returns the | and it returns the | ||
| Line 10: | Line 10: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%fastUnloadTaskState</th> | ||
<td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the state of | <td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the state of <var class="term">fastUnloadTask</var> after <var>FastUnloadTask (GetNextRecord function)|GetNextRecord</var> retrieves the record from <var class="term">fastUnloadTask</var>. | ||
</td></tr> | </td></tr> | ||
<tr><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> | ||
| Line 21: | Line 20: | ||
<var>GetNextRecord</var> can only be called when | <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. | If called in the <var>Done</var> state, the request is cancelled. | ||
==See also== | ==See also== | ||
{{Template:FastUnloadTask:GetNextRecord footer}} | {{Template:FastUnloadTask:GetNextRecord footer}} | ||
Revision as of 20:56, 29 April 2011
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 FastUnloadTask (GetNextRecord function)|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.