GetNextRecord (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:FastUnloadTask:GetNextRecord subtitle}} | |||
This [[Notation conventins for methods#Callable methods|callable]] | This [[Notation conventins for methods#Callable methods|callable]] | ||
| Line 12: | Line 7: | ||
value. | value. | ||
==Syntax== | ==Syntax== | ||
{{Template:FastUnloadTask:GetNextRecord syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 24: | Line 18: | ||
</td></tr></table> | </td></tr></table> | ||
==Usage | ==Usage notes== | ||
<var>GetNextRecord</var> can only be called when | <var>GetNextRecord</var> can only be called when | ||
''%funtask'' is in the <var>Started</var> or <var>HaveRecord</var> state. | ''%funtask'' 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== | |||
{{Template:FastUnloadTask:GetNextRecord footer}} | |||
Revision as of 20:39, 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
| %funtstate | A declared enumeration object of type FastUnloadTaskState to contain the state of %funtask after GetNextRecord retrieves the record from %funtask. |
|---|---|
| %funtask | An instantiated FastUnloadTask object variable. |
Usage notes
GetNextRecord can only be called when %funtask is in the Started or HaveRecord state. If called in the Done state, the request is cancelled.