UserStatistics (Daemon function): Difference between revisions
Jump to navigation
Jump to search
m (→Examples) |
m (match syntax table to syntax template, tags and edits) |
||
| 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> object. | |||
The method takes no arguments and returns a | |||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 8: | ||
===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 class|UserStatistics]]</var> 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 class|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 UserStatistics method is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.3. | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
<ol><li>The following statements return the <tt>%daemon</tt> thread User statistics to the <tt>%myDaemonStats</tt> object, then print the non-zero statistics contained therein: | |||
The following statements return the <tt>%daemon</tt> thread User statistics to the <tt>%myDaemonStats</tt> object, then print the non-zero statistics contained therein: | |||
<p class="code">%myDaemonStats = %daemon:userStatistics | <p class="code">%myDaemonStats = %daemon:userStatistics | ||
Print 'stats are: ' %myDaemonStats | Print 'stats are: ' %myDaemonStats | ||
</p> | </p></ol> | ||
==See also== | ==See also== | ||
<ul><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> | |||
{{Template:Daemon:UserStatistics footer}} | {{Template:Daemon:UserStatistics footer}} | ||
Revision as of 03:18, 14 March 2011
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 object.
Syntax
%userStatistics = daemon:UserStatistics Throws DaemonLost
Syntax terms
| %userStatistics | A UserStatistics 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.
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
See also
- For information about the user statistics that are returned and how to extract data from the returned object see "UserStatistics class".