UserStatistics (Daemon function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Daemon:UserStatistics subtitle}} | {{Template:Daemon:UserStatistics subtitle}} | ||
<var>UserStatistics</var> returns the <var class="product">Model 204</var> User statistics for the thread associated with the daemon object. It is useful for metering a daemon or for determining table usage by a compilation done on the daemon thread. | |||
The method takes no arguments and returns a <var>[[UserStatistics class|UserStatistics]]</var> class object. | |||
The method takes no arguments and returns a | |||
==Syntax== | ==Syntax== | ||
{{Template:Daemon:UserStatistics syntax}} | {{Template:Daemon:UserStatistics syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%userStatistics</th> | ||
<td>A UserStatistics object variable to contain the returned statistics. </td></tr> | <td>A <var>UserStatistics</var> class object variable to contain the returned statistics. </td></tr> | ||
<tr><th> | <tr><th>daemon</th> | ||
<td>A previously defined Daemon object.</td></tr> | <td>A previously defined <var>Daemon</var> object.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The daemon cannot be running asynchronously when this method is invoked. | <li>The daemon cannot be running asynchronously when this method is invoked. | ||
<li>The <var>UserStatistics</var> method is available as of <var class="product">Sirius Mods</var> Version 7.3. | |||
<li>For information about the user statistics that are returned and how to extract data from the returned object, see [[UserStatistics class|"UserStatistics class"]]. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
The following statements return the <code>%daemon</code> thread User statistics to the <code>%myDaemonStats</code> object, then print the non-zero statistics contained therein: | |||
The following statements return the < | <p class="code">%myDaemonStats = %daemon:userStatistics | ||
< | |||
%myDaemonStats = %daemon:userStatistics | |||
Print 'stats are: ' %myDaemonStats | Print 'stats are: ' %myDaemonStats | ||
</ | </p> | ||
==See also== | ==See also== | ||
{{Template:Daemon:UserStatistics footer}} | {{Template:Daemon:UserStatistics footer}} | ||
Latest revision as of 20:51, 8 July 2012
Statistics for the thread associated with this Daemon (Daemon class)
UserStatistics returns the Model 204 User statistics for the thread associated with the daemon object. It is useful for metering a daemon or for determining table usage by a compilation done on the daemon thread.
The method takes no arguments and returns a UserStatistics class object.
Syntax
%userStatistics = daemon:UserStatistics Throws DaemonLost
Syntax terms
| %userStatistics | A UserStatistics class object variable to contain the returned statistics. |
|---|---|
| daemon | A previously defined Daemon object. |
Usage notes
- The daemon cannot be running asynchronously when this method is invoked.
- The UserStatistics method is available as of Sirius Mods Version 7.3.
- For information about the user statistics that are returned and how to extract data from the returned object, see "UserStatistics class".
Examples
The following statements return the %daemon thread User statistics to the %myDaemonStats object, then print the non-zero statistics contained therein:
%myDaemonStats = %daemon:userStatistics Print 'stats are: ' %myDaemonStats