Report (FastUnloadTask function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (UL Interface becomes SOUL Interface) |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
{{Template:FastUnloadTask:Report syntax}} | {{Template:FastUnloadTask:Report syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 9: | Line 10: | ||
<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>fastUnloadTask</th> | <tr><th>fastUnloadTask</th> | ||
<td>An instantiated <var>FastUnloadTask</var> object variable. | <td>An instantiated <var>FastUnloadTask</var> object variable. | ||
| Line 15: | Line 17: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<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><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> | ||
<li><var>Report</var> can only be called if <var>ReportToStringlist</var> is set to <var>True</var> in | <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 | ||
the <var>Recordset</var> class <var>[[FastUnloadTask (Recordset function)|FastUnloadTask]]</var> method that created | the method object. Otherwise, the request is cancelled. </li> | ||
the method object. Otherwise, the request is cancelled. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:FastUnloadTask:Report footer}} | {{Template:FastUnloadTask:Report footer}} | ||
[[Category:Fast/Unload | [[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.