UserStatistics (Daemon function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Daemon:UserStatistics subtitle}} | |||
UserStatistics is a member of the [[Daemon class]] | UserStatistics is a member of the [[Daemon class]] | ||
| Line 7: | Line 7: | ||
The method takes no arguments and returns a UserStatistics object. For information about the user statistics that are returned and how to extract data from the returned object see [[UserStatistics class]]. | The method takes no arguments and returns a UserStatistics object. For information about the user statistics that are returned and how to extract data from the returned object see [[UserStatistics class]]. | ||
== | ==Syntax== | ||
{{Template:Daemon:UserStatistics syntax}} | |||
===Syntax terms=== | |||
===Syntax | |||
<dl> | <dl> | ||
<dt>%ustat | <dt>%ustat | ||
| Line 20: | Line 17: | ||
</dl> | </dl> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The UserStatistics method is available as of ''[[Sirius Mods]]'' Version 7.3. | <li>The UserStatistics method is available as of ''[[Sirius Mods]]'' Version 7.3. | ||
| Line 35: | Line 32: | ||
</pre> | </pre> | ||
==See also== | |||
{{Template:Daemon:UserStatistics footer}} | |||
Revision as of 04:37, 7 February 2011
Statistics for the thread associated with this Daemon (Daemon class)
UserStatistics is a member of the Daemon class
This method 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. For information about the user statistics that are returned and how to extract data from the returned object see UserStatistics class.
Syntax
%userStatistics = daemon:UserStatistics Throws DaemonLost
Syntax terms
- %ustat
- A UserStatistics object variable to contain the returned statistics.
- %daem
- A previously defined Daemon object.
Usage notes
- The UserStatistics method is available as of Sirius Mods Version 7.3.
- The daemon cannot be running asynchronously when this method is invoked.
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