$DaemonParentNumber: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 8: Line 8:
The $DaemonParentNumber function accepts no arguments.
The $DaemonParentNumber function accepts no arguments.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %USERN = $DaemonParentNumber
<p class="syntax"><section begin="syntax" />%USERN = $DaemonParentNumber
<section end="syntax" /></p>
<section end="syntax" /></p>
<p class="caption">$DaemonParentNumber Function
<p class="caption">$DaemonParentNumber Function

Revision as of 20:32, 24 October 2012

Get user number of parent thread

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $DaemonParentNumber function is the ParentNumber (Daemon property). The OO APIs emphasize the use of the Daemon methods; users are strongly urged to use the new Daemon API instead of the old $functions.

This function can be used to get the user number of an sdaemon's parent thread.

The $DaemonParentNumber function accepts no arguments.

Syntax

<section begin="syntax" />%USERN = $DaemonParentNumber <section end="syntax" />

$DaemonParentNumber Function

%USERN is set to parent's user number, or to -1 if not called from a daemon

The $DaemonParentNumber function returns the user number of the thread that created the daemon thread, whether the daemon is associated with a Daemon object or with a $COMMxx function.

If the thread issuing $DaemonParentNumber is not an sdaemon, or is an sdaemon but is not performing work for another thread via a Daemon object or a $COMMxx function, or is an asynchronous daemon, the $DaemonParentNumber function returns a -1 value. The following code audits a thread's parent user number:

audit 'My parents user number is ' $DaemonParentNumber

This $function is new in Version 6.8 of the Sirius Mods.