The NEEDS_XMIT function takes one or more property parameters, expects each to be an object, and returns true if the last parameter is an object and that object or one of its descendent objects in the module data structure has a pending transaction. If multiple parameters are provided to the function, the first parameter is evaluated in the context of the function call. Each subsequent parameter is evaluated in the context of the parameter that precedes it. If any parameter evaluates to any definition instance other than an object, the evaluation ends and the function returns false.
In most current implementations of this function, a single parameter is provided that is a target path to an object instance selected using the target browser. If a pending transaction targets this object or any of its descendent objects, this function will return true. Otherwise it returns false.
@NEEDS_XMIT (Property 1 [, ..., Property N]) | |
---|---|
Property 1 | Required property parameter; evaluated by the function to determine
if it is an object instance first, and if a pending transaction
exists that targets this object or any of its descendent object
instances second. In current implementations and uses for this function,
this is the only parameter provided in most cases. |
Property N | Optional property parameters; each is evaluated in the context
of the parameter before it in the function’s parameter list. These
parameters are expected to evaluate to an object instance. The last
parameter in this list is evaluated by the function for pending
transactions targeting it or any of its descendent object instances. |
Boolean