CurrentRecord (FastUnloadTask function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with " <span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> CurrentRecord function <p> <var>CurrentRecord</var> is a m...")
 
m (UL Interface becomes SOUL Interface)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:FastUnloadTask:CurrentRecord subtitle}}


<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:FastUnloadTask methods|CurrentRecord function]]
<p>
<var>CurrentRecord</var> is a member of the <var>[[FastUnloadTask class|FastUnloadTask]]</var> class.
</p>
This method returns the contents of the current record from the <var class="product">[[Fast/Unload]]</var> task
as a longstring.
==Syntax==
==Syntax==
<p class="syntax">%ls = %funtask:CurrentRecord
{{Template:FastUnloadTask:CurrentRecord syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%ls</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>%funtask</th>
<td>An instantiated <var>FastUnloadTask</var> object variable.


</td></tr></table>
<tr><th>fastUnloadTask</th>
==Usage Notes==
<td>A <var>FastUnloadTask</var> object variable.</td></tr>
</table>


<var>CurrentRecord</var> can only be called when
==Usage notes==
''%funtask'' is in the <var>HaveRecord</var> state.
<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.
If called in any other state, the request is cancelled.
</ul>
==See also==
{{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

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