DifferenceToString (UserStatistics function): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template, tags and edits) |
mNo edit summary |
||
| (10 intermediate revisions by 5 users not shown) | |||
| 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. | 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>%string</th> | <tr><th>%string</th> | ||
<td>A <var>longstring</var> variable to contain the listing of the difference values of the | <td>A <var>longstring</var> variable to contain the listing of the difference values of the Login statistics. </td></tr> | ||
<tr><th>userStatatistics</th> | <tr><th>userStatatistics</th> | ||
<td>A <var>UserStatistics</var> object variable. </td></tr> | <td>A <var>UserStatistics</var> object variable. </td></tr> | ||
<tr><th>ustatOld</th> | <tr><th>ustatOld</th> | ||
<td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatatistics</var>. </td></tr> | <td>An older <var>UserStatistics</var> object variable for the same user login as <var class="term">userStatatistics</var>. </td></tr> | ||
<tr><th>Zeros</th> | |||
<td>This | <tr><th><var>Zeros</var></th> | ||
<tr><th>NamesToLower</th><td></td></tr> | <td>This [[Methods#Named parameters|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var> value that indicates whether differences with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in non-zero values only being included.</td></tr> | ||
<tr><th><var>NamesToLower</var></th> | |||
<td>This name required argument is a <var>Boolean</var> value that indicates whether the returned <var class="product">Model 204</var> statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument that defaults to <var>False</var>.</td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<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. | <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 (<var>CPU</var>, for example) have corresponding Login statistics that return the exact same difference. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
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>: | 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>: | ||
<p class="code">print %ustat2:differenceToString(%ustat1) | <p class="code">print %ustat2:differenceToString(%ustat1) | ||
</p> | </p> | ||
==See also== | ==See also== | ||
Latest revision as of 21:29, 20 November 2012
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 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 | This name required argument is a Boolean value that indicates whether the returned Model 204 statistic names, which are normally all-uppercase, should be returned as lowercase. This is an optional argument that defaults to False. |
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 %ustat1 to 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.