ReturnCode (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:FastUnloadTask:ReturnCode subtitle}} | |||
This function returns the <var class="product">[[Fast/Unload]]</var> numeric return code. | This function returns the <var class="product">[[Fast/Unload]]</var> numeric return code. | ||
==Syntax== | ==Syntax== | ||
{{Template:FastUnloadTask:ReturnCode syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 21: | Line 15: | ||
<var>ReturnCode</var> can only be called when ''%funtask'' is in the <var>Done</var> state. | <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. | If called in any other state, the request is cancelled. | ||
==See also== | |||
{{Template:FastUnloadTask:ReturnCode footer}} | |||
Revision as of 20:39, 29 April 2011
Return Fast/Unload return code (FastUnloadTask class)
This function returns the Fast/Unload numeric return code.
Syntax
%number = fastUnloadTask:ReturnCode
Syntax terms
| %rc | A numeric variable to contain the Fast/Unload return code. |
|---|---|
| %funtask | An instantiated FastUnloadTask object variable. |
ReturnCode can only be called when %funtask is in the Done state. If called in any other state, the request is cancelled.