ReturnCode (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| 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">[[Fast/Unload]]</var> return code. | <td>A numeric variable to contain the <var class="product">[[Fast/Unload]]</var> 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 | <var>ReturnCode</var> can only be called when <var class="term">fastUnloadTask</var> is in the <var>Done</var> state. | ||
If called in any other state, the request is cancelled. | If called in any other state, the request is cancelled. | ||
==See also== | ==See also== | ||
{{Template:FastUnloadTask:ReturnCode footer}} | {{Template:FastUnloadTask:ReturnCode footer}} | ||
Revision as of 20:49, 29 April 2011
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. |
ReturnCode can only be called when fastUnloadTask is in the Done state. If called in any other state, the request is cancelled.