GetInputObject (Daemon subroutine): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
(Automatically generated page update) |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Daemon:GetInputObject subtitle}} | {{Template:Daemon:GetInputObject subtitle}} | ||
<var>GetInputObject</var> retrieves the input object passed by the master thread (in the second argument of the <var>[[Run (Daemon function)|Run]]</var> method) making it available to the daemon. | |||
GetInputObject | |||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%(Daemon)</th> | <tr><th><var class="nobr">%(Daemon)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>GetInputObject</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>GetInputObject</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr> | ||
<tr><th> | <tr><th>object</th> | ||
<td>The object passed to the daemon method object in the | <td>The object passed to the daemon method object in the most recent <var>Daemon</var> <var>[[Run (Daemon function)|Run]]</var> invocation. <var class="term">object</var> must be deep copyable, as described in [[Copying objects|"Copying objects"]].</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li><var>GetInputObject</var> may not be issued on a master thread. | |||
<li>GetInputObject may not be issued on a master thread. | <li>If the input object passed by Daemon <var>[[Run (Daemon function)|Run]]</var> does not match the <var class="term">object</var> argument of <var>GetInputObject</var>, the request containing <var>GetInputObject</var> is cancelled. | ||
<li>If the input object passed by | <li><var>GetInputObject</var> sets its argument to null if no object or a null object is passed by <var>[[Run (Daemon function)|Run]]</var>, and any subsequent references to that object cancel the request. | ||
<li>GetInputObject sets its argument to null if no object or a null object is passed by Run, and subsequent references to that object cancel the request. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Daemon:GetInputObject footer}} | {{Template:Daemon:GetInputObject footer}} | ||
Latest revision as of 00:56, 16 February 2014
Retrieve input object passed by master thread (Daemon class)
GetInputObject retrieves the input object passed by the master thread (in the second argument of the Run method) making it available to the daemon.
Syntax
%(Daemon):GetInputObject( object)
Syntax terms
| %(Daemon) | The class name in parentheses denotes a shared method. GetInputObject can also be invoked via a Daemon object variable, which may be null. |
|---|---|
| object | The object passed to the daemon method object in the most recent Daemon Run invocation. object must be deep copyable, as described in "Copying objects". |
Usage notes
- GetInputObject may not be issued on a master thread.
- If the input object passed by Daemon Run does not match the object argument of GetInputObject, the request containing GetInputObject is cancelled.
- GetInputObject sets its argument to null if no object or a null object is passed by Run, and any subsequent references to that object cancel the request.