LoginToString (UserStatistics function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span style="font-size:120%; color:black"><b>Longstring containing UserStatistics object's Login stat</b></span>
{{Template:UserStatistics:LoginToString subtitle}}
[[Category:UserStatistics methods|LoginToString function]]
<!--DPL?? Category:UserStatistics methods|LoginToString function: Longstring containing UserStatistics object's Login stat-->
<!--DPL?? Category:System methods|LoginToString (UserStatistics function): Longstring containing UserStatistics object's Login stat-->
<p>
LoginToString is a member of the [[UserStatistics class]].
</p>
   
   
This function returns the values of the [[UserStatistics class#login|Login]] (also called Final) statistics in the method UserStatistics object.
This function returns the values of the [[UserStatistics class#login|Login]] (also called Final) statistics in the method UserStatistics object.
The method prints all Login statistics with non-zero values (by default),
The method prints all Login statistics with non-zero values (by default),
or it prints all Login statistics (as an option).
or it prints all Login statistics (as an option).
===Syntax===
==Syntax==
  %ls = %ustat:LoginToString([Zeros=bool])
{{Template:UserStatistics:LoginToString syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<dl>
Line 27: Line 21:
   
   
</dl>
</dl>
===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>The [[RequestToString (UserStatistics function)|RequestToString]] function
<li>The [[RequestToString (UserStatistics function)|RequestToString]] function
Line 35: Line 29:
returns the values of all the statistics in the object.
returns the values of all the statistics in the object.
</ul>
</ul>
===Examples===
==Examples==
   
   
The following example of non-zero Login statistics is produced by a
The following example of non-zero Login statistics is produced by a
Line 46: Line 40:
jswap=250247
jswap=250247
</nowiki></p>
</nowiki></p>
==See also==
{{Template:UserStatistics:LoginToString footer}}

Revision as of 20:42, 14 March 2011

Login statistics in string format (UserStatistics class)


This function returns the values of the Login (also called Final) statistics in the method UserStatistics object. The method prints all Login statistics with non-zero values (by default), or it prints all Login statistics (as an option).

Syntax

%string = userStatistics:LoginToString[( [Zeros= boolean], - [NamesToLower= boolean])]

Syntax terms

%ls
A longstring variable to contain the listing of the values of the Login statistics.
%ustat
A UserStatistics object variable.
Zeros= bool
This name required argument (Zeros) is a boolean value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to False, which results in the inclusion of only statistics with non-zero values.

Usage notes

  • The RequestToString function returns the values of the Request statistics in the UserStatistics object. The ToString function returns the values of all the statistics in the object.

Examples

The following example of non-zero Login statistics is produced by a
Print %ustat:loginToString statement. The output line wrapping is altered for display purposes.

time='20080902160613043' userNumber=20 loginTime='2008090- 2094309010' cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 req=1 - move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=996 ob- jswap=250247

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=LoginToString_(UserStatistics_function)&oldid=13538"