DifferenceToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
DifferenceToString is a member of the [[UserStatistics class]]. | DifferenceToString is a member of the [[UserStatistics class]]. | ||
</p> | </p> | ||
This method returns to a longstring the difference in values between one UserStatistics | This method returns to a longstring the difference in values between one UserStatistics | ||
object and another for all Login statistics with non-zero values (by default) | object and another for all Login statistics with non-zero values (by default) | ||
or for all Login statistics (as an option). | or for all Login statistics (as an option). | ||
See the description of [[UserStatistics class#login|Login statistics]]. | See the description of [[UserStatistics class#login|Login statistics]]. | ||
===Syntax=== | ===Syntax=== | ||
| Line 30: | Line 30: | ||
Zeros is an optional argument that defaults to <tt>False</tt>, which | Zeros is an optional argument that defaults to <tt>False</tt>, which | ||
results in non-zero values only being included. | results in non-zero values only being included. | ||
</dl> | </dl> | ||
===Usage Notes=== | ===Usage Notes=== | ||
| Line 46: | Line 46: | ||
</ul> | </ul> | ||
===Examples=== | ===Examples=== | ||
The following statement returns all the Login statistics that have | The following statement returns all the Login statistics that have | ||
non-zero difference values over the interval from the creation of | non-zero difference values over the interval from the creation of | ||
%ustat1 to the creation of %ustat2: | %ustat1 to the creation of %ustat2: | ||
< | <p class="code"><nowiki>Print %ustat2:differenceToString(%ustat1) | ||
</nowiki></p> | |||
</ | |||
Revision as of 16:50, 28 February 2011
Longstring with difference of all Login statistic v
DifferenceToString is a member of the UserStatistics class.
This method returns to a longstring the difference in values between one UserStatistics object and another for all Login statistics with non-zero values (by default) or for all Login statistics (as an option).
See the description of Login statistics.
Syntax
%ls = %ustat:DifferenceToString(%ustatOld [, Zeros=bool])
Syntax terms
- %ls
- A longstring variable to contain the listing of the difference values of the Login statistics.
- %ustat
- A UserStatistics object variable.
- %ustatOld
- An older UserStatistics object variable for the same user login as %ustat.
- Zeros= bool
- This name required argument (Zeros) is a boolean value that indicates whether differences with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in non-zero values only being included.
Usage Notes
- 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.
- The Difference function returns the value differences between two UserStatistics objects for the Login statistic you specify. The DifferenceToXmlDoc function returns to an XmlDoc object the differences for all, or all non-zero, Login statistics.
Examples
The following statement returns all the Login statistics that have non-zero difference values over the interval from the creation of %ustat1 to the creation of %ustat2:
Print %ustat2:differenceToString(%ustat1)