Difference (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:Difference subtitle}} | |||
This function returns the difference in [[UserStatistics class#login|Login]] | This function returns the difference in [[UserStatistics class#login|Login]] | ||
(also called “Final”) statistic values | (also called “Final”) statistic values | ||
between one UserStatistics object and another. | between one UserStatistics object and another. | ||
The Difference method cancels the request if it is applied to a statistic | The Difference method cancels the request if it is applied to a statistic | ||
[[UserStatistics class#request|Request statistic]]. | [[UserStatistics class#request|Request statistic]]. | ||
==Syntax== | |||
{{Template:UserStatistics:Difference syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 31: | Line 25: | ||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | <li>The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified | ||
| Line 47: | Line 41: | ||
to an XmlDoc object. | to an XmlDoc object. | ||
</ul> | </ul> | ||
==Examples== | |||
The following example returns | The following example returns | ||
| Line 61: | Line 55: | ||
end | end | ||
</nowiki></p> | </nowiki></p> | ||
==See also== | |||
{{Template:UserStatistics:Difference footer}} | |||
Revision as of 20:42, 14 March 2011
Difference in login statistics (UserStatistics class)
This function returns the difference in Login
(also called “Final”) statistic values
between one UserStatistics object and another.
The Difference method cancels the request if it is applied to a statistic Request statistic.
Syntax
%number = userStatistics:Difference( ustatOld, string) Throws UnknownStatistic
Syntax terms
- %dif
- A numeric variable to contain the difference between the values of the specified statistic contained in the method object and contained in the older UserStatistics object.
- %ustat
- A UserStatistics object variable.
- %ustatOld
- An older UserStatistics object variable for the same user login as %ustat.
- statistic
- This case-independent string contains the name of a Model 204 user Login statistic All other names return an UnknownStatistic exception.
Usage notes
- The statistics UpdtTime(MS) and LongupdTime(MS) can also be specified without the parentheses: for example, UpdtTimeMs and LongUpdtimeMs, respectively.
- Request statistics are not valid for the Difference method since most don't really make sense for this operation. The Request statistics for which it does make sense (CPU, for example) have corresponding Login statistics that return the exact same difference.
- Some statistics (like PCPU) don't really make sense as a difference but the Difference method returns a difference anyway.
- The DifferenceToString function returns the value differences between two UserStatistics objects for the Login statistics. The DifferenceToXmlDoc function returns the differences to an XmlDoc object.
Examples
The following example returns the amount of CPU a request uses and how many DKRDs it did:
b %statStart is object userStatistics %statEnd is object userStatistics %statStart = new ... processing %statEnd = new printText CPU: {%statEnd:difference(%statStart, 'CPU')} printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} end