GetInputObject (Daemon subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 8: Line 8:
{{Template:Daemon:GetInputObject syntax}}
{{Template:Daemon:GetInputObject syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>%(Daemon)  
<tr><th>%(Daemon)</th>
<dd>The class name in parentheses denotes a shared method. Specifying <tt>%(Daemon):</tt> is not the only way to invoke the method (see [[Daemon class]].).  
<td>The class name in parentheses denotes a shared method. Specifying <tt>%(Daemon):</tt> is not the only way to invoke the method (see [[Daemon class]].). </td></tr>
<dt><i>%inputObj</i>  
<tr><th><i>%inputObj</i></th>
<dd>The object passed to the daemon method object in the last Run method invocation. '''%inputObj''' must be deep copyable, as described in [[Copying objects]].
<td>The object passed to the daemon method object in the last Run method invocation. '''%inputObj''' must be deep copyable, as described in [[Copying objects]].</td></tr>
</dl>
</table>


==Usage notes==
==Usage notes==

Revision as of 04:37, 7 February 2011

Retrieve input object passed by master thread (Daemon class)


GetInputObject is a member of the Daemon class

This shared method retrieves the input object passed by the master thread (in the second argument of the Run method) and makes it available to the daemon.

Syntax

%(Daemon):GetInputObject( object)

Syntax terms

%(Daemon) The class name in parentheses denotes a shared method. Specifying %(Daemon): is not the only way to invoke the method (see Daemon class.).
%inputObj The object passed to the daemon method object in the last Run method invocation. %inputObj 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 the Run method does not match the %inputObj 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 subsequent references to that object cancel the request.


See also