ReturnCode (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:FastUnloadTask:ReturnCode subtitle}} | {{Template:FastUnloadTask:ReturnCode subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:FastUnloadTask:ReturnCode syntax}} | {{Template:FastUnloadTask:ReturnCode syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the <var class="product"> | <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> | <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 | |||
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== | ==See also== | ||
{{Template:FastUnloadTask:ReturnCode footer}} | {{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.