ReturnCode (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> ReturnCode function <p> <var>ReturnCode</var> is a member ...")
 
No edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:FastUnloadTask:ReturnCode subtitle}}


<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:FastUnloadTask methods|ReturnCode function]]
<p>
<var>ReturnCode</var> is a member of the <var>[[FastUnloadTask class|FastUnloadTask]]</var> class.
</p>
This function returns the <var class="product">[[Fast/Unload]]</var> numeric return code.
==Syntax==
==Syntax==
<p class="syntax">%rc = %funtask:ReturnCode
{{Template:FastUnloadTask:ReturnCode syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%rc</th>
<tr><th>%number</th>
<td>A numeric variable to contain the <var class="product">[[Fast/Unload]]</var> return code.
<td>A numeric variable to contain the <var class="product">Fast/Unload</var> [[Fast/Unload program return codes|return code]].
</td></tr>
</td></tr>
<tr><th>%funtask</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>
<var>ReturnCode</var> can only be called when ''%funtask'' is in the <var>Done</var> state.
 
If called in any other state, the request is cancelled.
==Usage notes==
<ul>
<li><var>ReturnCode</var> can only be called when <var class="term">fastUnloadTask</var> is in the <var>Done</var> [[FastUnloadTask class#The FastUnloadTaskState enumeration|state]]. If called in any other state, the request is cancelled.
</ul>
 
==See also==
{{Template:FastUnloadTask:ReturnCode footer}}
[[Category:Fast/Unload SOUL Interface]]

Latest revision as of 20:18, 31 July 2015

Return Fast/Unload return code (FastUnloadTask class)


Syntax

%number = fastUnloadTask:ReturnCode

Syntax terms

%number A numeric variable to contain the Fast/Unload return code.
fastUnloadTask An instantiated FastUnloadTask object variable.

Usage notes

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

See also

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