DifferenceToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:UserStatistics:DifferenceToString subtitle}} | {{Template:UserStatistics:DifferenceToString subtitle}} | ||
The <var>DifferenceToString</var> method returns, to a <var>longstring</var>, the difference in values between one <var>[[UserStatistics_class|UserStatistics]]</var> object and another for all [[UserStatistics class#login|Login]] (also called "Final") statistics with non-zero values (by default) or for all Login statistics including those with zero values. | |||
==Syntax== | ==Syntax== | ||
{{Template:UserStatistics:DifferenceToString syntax}} | {{Template:UserStatistics:DifferenceToString syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%string</th> | ||
<td>A longstring variable to contain the listing of the difference values of the Login statistics. </td></tr> | <td>A <var>longstring</var> variable to contain the listing of the difference values of the <var>Login</var> statistics. </td></tr> | ||
<tr><th> | <tr><th>userStatatistics</th> | ||
<td>A UserStatistics object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><th> | <tr><th>ustatOld</th> | ||
<td>An older UserStatistics object variable for the same user login as | <td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatatistics</var>. </td></tr> | ||
<tr><th | <tr><th>Zeros</th> | ||
<td>This <var>[[Methods#Named parameters|Name-Required]]</var> argument (<var class="term">Zeros</var>) is a <var>[[boolean]]</var> value that indicates whether differences with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <code>False</code>, which results in non-zero values only being included.</td></tr> | |||
<tr><th>NamesToLower</th><td></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>[[UserStatistics class#request|Request statistics]] | <li>[[UserStatistics class#request|Request statistics]] are not valid for <var>DifferenceToString</var> 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. | ||
are not valid for | |||
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 | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
<ol><li> | |||
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 <code>%ustat1</code> to the creation of <code>%ustat2</code>: | ||
non-zero difference values over the interval from the creation of | <p class="code">print %ustat2:differenceToString(%ustat1) | ||
%ustat1 to the creation of %ustat2: | </p> | ||
<p class="code"> | </ol> | ||
</ | |||
==See also== | ==See also== | ||
<ul> | |||
<li><var>[[Difference (UserStatistics function)|Difference]]</var> which returns the value differences between two <var>UserStatistics</var> objects for the Login statistic you specify. | |||
<li><var>[[DifferenceToXmlDoc (UserStatistics function)|DifferenceToXmlDoc]]</var> which returns to an <var>[[XmlDoc_class#The_XmlDoc_class|XmlDoc]]</var> object the differences for all, or all non-zero, Login statistics. | |||
</ul> | |||
{{Template:UserStatistics:DifferenceToString footer}} | {{Template:UserStatistics:DifferenceToString footer}} | ||
Revision as of 10:37, 30 March 2011
Login timestamps difference in string format (UserStatistics class)
The DifferenceToString method returns, to a longstring, the difference in values between one UserStatistics object and another for all Login (also called "Final") statistics with non-zero values (by default) or for all Login statistics including those with zero values.
Syntax
%string = userStatistics:DifferenceToString( ustatOld, [Zeros= boolean], - [NamesToLower= boolean])
Syntax terms
| %string | A longstring variable to contain the listing of the difference values of the Login statistics. |
|---|---|
| userStatatistics | A UserStatistics object variable. |
| ustatOld | An older UserStatistics object variable for the same user login as userStatatistics. |
| Zeros | 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. |
| NamesToLower |
Usage notes
- Request statistics are not valid for DifferenceToString 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.
Examples
-
The following statement returns all the Login statistics that have non-zero difference values over the interval from the creation of
%ustat1to the creation of%ustat2:print %ustat2:differenceToString(%ustat1)
See also
- Difference which returns the value differences between two UserStatistics objects for the Login statistic you specify.
- DifferenceToXmlDoc which returns to an XmlDoc object the differences for all, or all non-zero, Login statistics.