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


<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
This function returns a <var>Stringlist</var> that contains the <var class="product">[[Fast/Unload]]</var> report data.
[[Category:FastUnloadTask methods|Report function]]
==Syntax==
<p>
{{Template:FastUnloadTask:Report syntax}}
<var>Report</var> is a member of the <var>[[FastUnloadTask class|FastUnloadTask]]</var> class.
</p>


This function returns a Stringlist that contains the <var class="product">[[Fast/Unload]]</var> report data.
==Syntax==
<p class="syntax">%strl = %funtask:Report
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%strl</th>
<tr><th>%sl</th>
<td>A <var>Stringlist</var> object variable to contain the <var class="product">[[Fast/Unload]]</var> report contents.
<td>A <var>Stringlist</var> object variable to contain the <var class="product">Fast/Unload</var> report contents.
</td></tr>
</td></tr>
<tr><th>%funtask</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>
==Usage notes==
==Usage Notes==
<ul>
<ul>
<li>Report can only be called when
<li><var>Report</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. </li>
''%funtask'' is in the <var>Done</var> state.
 
If called in any other state, the request is cancelled.
<li><var>Report</var> can only be called if <var>ReportToStringlist</var> is set to <var>True</var> in the <var>Recordset</var> class <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var> method that created
<li><var>Report</var> can only be called if <var>ReportToStringlist</var> is set to <var>True</var> in
the method object. Otherwise, the request is cancelled. </li>
the <var>Recordset</var> class <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var> method that created
the method object.
Otherwise, the request is cancelled.
</ul>
</ul>
==See also==
{{Template:FastUnloadTask:Report footer}}
[[Category:Fast/Unload SOUL Interface]]

Latest revision as of 21:38, 16 March 2015

Return Fast/Unload report contents (FastUnloadTask class)


This function returns a Stringlist that contains the Fast/Unload report data.

Syntax

%sl = fastUnloadTask:Report

Syntax terms

%sl A Stringlist object variable to contain the Fast/Unload report contents.
fastUnloadTask An instantiated FastUnloadTask object variable.

Usage notes

  • Report can only be called when fastUnloadTask is in the Done state. If called in any other state, the request is cancelled.
  • Report can only be called if ReportToStringlist is set to True in the Recordset class FastUnloadTask method that created the method object. Otherwise, the request is cancelled.

See also

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