ToString (UserStatistics function)

From m204wiki
Jump to navigation Jump to search

Print UserStatistics values (UserStatistics class)

ToString returns the values of the statistics in the method UserStatistics object. By default, it will only return statistics with non-zero values; but, as an option, it may return all (including zero) statistics.


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

Syntax terms

%string A longstring variable to receive the listing of the values of the statistics.
userStatistics A UserStatistics object variable.
Zeros This name required argument 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.
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 which defaults to False.

Usage notes

  • ToString can be applied implicitly: simply Print (or Audit) an object variable, and the ToString method is automatically applied to the object. That is:

    print %statobject

    is equivalent to:

    print %statobject:ToString


The following display of non-zero Login and Request statistics is produced by a

print %ustat


time='20080730102646772' userNumber=6 loginTime='20080730102645880' 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=889 dkpr=124750 objswap=250247

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

See also

  • LoginToString returns the values of the Login statistics in the UserStatistics object.
  • RequestToString returns the values of the Request statistics in the object.