State (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> State function <p> <var>State</var> is a member of the <va...")
 
m (UL Interface becomes SOUL Interface)
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{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.


<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
==Syntax==
[[Category:FastUnloadTask methods|State function]]
{{Template:FastUnloadTask:State syntax}}
<p>
<var>State</var> is a member of the <var>[[FastUnloadTask class|FastUnloadTask]]</var> class.
</p>


This method returns the current state of the <var>FastUnloadTask</var> method object as a
<var>FastUnloadTaskState</var> enumeration value.
==Syntax==
<p class="syntax">[%funtstate =] %funtask:State
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%funtstate</th>
<tr><th>%fastUnloadTaskState</th>
<td>A declared enumeration object of type <var>FastUnloadTaskState</var> to contain the current state of ''%funtask''.
<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>%funtask</th>
<tr><th>fastUnloadTask</th>
<td>An instantiated <var>FastUnloadTask</var> object variable.
<td>A <var>FastUnloadTask</var> object.</td></tr>
</table>
 
==Usage notes==
<ul>
<li>The <var>State</var> method can be called when <var class="term">fastUnloadTask</var> is in any state.
</ul>


</td></tr></table>
==See also==
==Usage Notes==
{{Template:FastUnloadTask:State footer}}


The <var>State</var> method can be called when ''%funtask'' is in any state.
[[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.

See also

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