UserStatistics methods syntax

The syntax for each of the UserStatistics class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of UserStatistics methods.

%outUserStatistics = userStatistics:Copy

%outUserStatistics = userStatistics:DeepCopy

%number = userStatistics:Difference( ustatOld, string)

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

%doc = userStatistics:DifferenceToXmlDoc( ustatOld, [Zeros= boolean], - [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean])

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

%userStatistics = [%(UserStatistics):]New

%number = userStatistics:Rate( ustatOld, string)

%number = userStatistics:RatePerSecond( ustatOld, string)

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

%number = userStatistics:RequestValue( string)

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

%doc = userStatistics:ToXmlDoc[( [Zeros= boolean], - [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean])]

%number = userStatistics:Value( string)