CurrentRecord (FastUnloadTask function): Difference between revisions

Latest revision as of 20:44, 16 March 2015

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

%string = fastUnloadTask:CurrentRecord

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

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

@@ Line 1: / Line 1: @@
 {{Template:FastUnloadTask:CurrentRecord subtitle}}
-This method returns the contents of the current record from the <var class="product">[[Fast/Unload]]</var> task
-as a longstring.
 ==Syntax==
 {{Template:FastUnloadTask:CurrentRecord syntax}}
 ===Syntax terms===
 <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>
+<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==
+<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
-''%funtask'' is in the <var>HaveRecord</var> state.
-If called in any other state, the request is cancelled.
 ==See also==
 {{Template:FastUnloadTask:CurrentRecord footer}}
+[[Category:Fast/Unload SOUL Interface]]

FastUnloadTask class	List of FastUnloadTask methods	FastUnloadTask methods syntax
Notation conventions for methods