State (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (UL Interface becomes SOUL Interface) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:FastUnloadTask:State subtitle}} | {{Template:FastUnloadTask:State subtitle}} | ||
This method returns the current state of the <var>FastUnloadTask</var> method object as a | |||
<var>[[FastUnloadTask class#The FastUnloadTaskState enumeration|FastUnloadTaskState]]</var> [[Enumerations|enumeration]] value. | |||
==Syntax== | ==Syntax== | ||
{{Template:FastUnloadTask:State syntax}} | {{Template:FastUnloadTask:State syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%fastUnloadTaskState</th> | ||
<td> | <td>An enumeration object of type <var>FastUnloadTaskState</var> which is set to the current state of <var class="term">fastUnloadTask</var>.</td></tr> | ||
</td></tr> | |||
<tr><th> | <tr><th>fastUnloadTask</th> | ||
<td> | <td>A <var>FastUnloadTask</var> object.</td></tr> | ||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>The <var>State</var> method can be called when <var class="term">fastUnloadTask</var> is in any state. | |||
</ul> | |||
==See also== | ==See also== | ||
{{Template:FastUnloadTask:State footer}} | {{Template:FastUnloadTask:State footer}} | ||
[[Category:Fast/Unload SOUL Interface]] | |||
Latest revision as of 21:40, 16 March 2015
Return state of this FastUnloadTask object (FastUnloadTask class)
This method returns the current state of the FastUnloadTask method object as a FastUnloadTaskState enumeration value.
Syntax
%fastUnloadTaskState = fastUnloadTask:State
Syntax terms
| %fastUnloadTaskState | An enumeration object of type FastUnloadTaskState which is set to the current state of fastUnloadTask. |
|---|---|
| fastUnloadTask | A FastUnloadTask object. |
Usage notes
- The State method can be called when fastUnloadTask is in any state.