CurrentRecord (FastUnloadTask function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
m (UL Interface becomes SOUL Interface)
 
(2 intermediate revisions by 2 users not shown)
Line 6: Line 6:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%string</th>
<tr><th>%string</th>
<td>A Longstring variable to contain the current record contents.
<td>A <var>[[Longstrings|Longstring]]</var> variable to contain the current record contents.</td></tr>
</td></tr>
 
<tr><th>fastUnloadTask</th>
<tr><th>fastUnloadTask</th>
<td>An instantiated <var>FastUnloadTask</var> object variable.
<td>A <var>FastUnloadTask</var> object variable.</td></tr>
</table>


</td></tr></table>
==Usage notes==
==Usage notes==
<ul>
<li><var>CurrentRecord</var> can only be called when
<var class="term">fastUnloadTask</var> is in the <var>HaveRecord</var> [[FastUnloadTask class#The FastUnloadTaskState enumeration|state]].
If called in any other state, the request is cancelled.
</ul>


<var>CurrentRecord</var> can only be called when
<var class="term">fastUnloadTask</var> is in the <var>HaveRecord</var> state.
If called in any other state, the request is cancelled.
==See also==
==See also==
{{Template:FastUnloadTask:CurrentRecord footer}}
{{Template:FastUnloadTask:CurrentRecord footer}}
[[Category:Fast/Unload SOUL Interface]]

Latest revision as of 20:44, 16 March 2015

Return current record from Fast/Unload as Longstring (FastUnloadTask class)


Syntax

%string = fastUnloadTask:CurrentRecord

Syntax terms

%string A Longstring variable to contain the current record contents.
fastUnloadTask A FastUnloadTask object variable.

Usage notes

  • CurrentRecord can only be called when fastUnloadTask is in the HaveRecord state. If called in any other state, the request is cancelled.

See also