ToString (UserStatistics function)

From m204wiki
Revision as of 19:51, 17 December 2010 by Dme (talk | contribs) (→‎Usage Notes)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Longstring with values of statistics in specified UserStatist

ToString is a member of the UserStatistics class.

This method prints the values of the statistics in the method UserStatistics object. It prints all statistics with non-zero values (by default), or it prints all statistics (as an option).

Syntax

  %ls = %ustat:ToString([Zeros=bool])

Syntax terms

%ls
A longstring variable to contain the listing of the values of the 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 ToString method can be applied implicitly: simply Print (or Audit) an object variable, and the ToString method is automatically applied to the object. Print %statobject is equivalent to Print %statobject:ToString.
  • The LoginToString function returns the values of the Login statistics in the UserStatistics object. The RequestToString function returns the values of the Request statistics in the object.

Examples

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

    time='20080730102646772' userNumber=6 loginTime='20080730-
    102645880' login: cnct=1 sqrd=29 sqwr=4 sgmto=27 cpu=890 -
    req=1 move=97 slic=71 audit=32 dkar=253 dkpr=124751 pcpu=-
    996 objswap=250247 request: ntbl=10 qtbl=29 stbl=524 vtbl-
    =51 pdl=508 cnct=1 cpu=887 out=1 slic=71 pcpu=996 rqtm=88-
    9 dkpr=124750 objswap=250247

A Print %ustat:ToString(Zeros=true) statement would print all the statistics, including those with a 0 value.