Share via


PosCommon.RetrieveStatistics Method (StatisticCategories)

2/27/2008

Retrieves the statistics for the specified category.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Function RetrieveStatistics ( _
    statistics As StatisticCategories _
) As String
public abstract string RetrieveStatistics (
    StatisticCategories statistics
)
public:
virtual String^ RetrieveStatistics (
    StatisticCategories statistics
) abstract
public abstract String RetrieveStatistics (
    StatisticCategories statistics
)
public abstract function RetrieveStatistics (
    statistics : StatisticCategories
) : String

Parameters

  • statistics

Remarks

RetrieveStatistics is always executed synchronously.

RetrieveStatistics returns a string of statistics if it is successful. It may throw a PosControlException with the following values:

Value

Meaning

Illegal

One of the following conditions has occurred:

  • The CapStatisticsReporting property is set to false. This indicates that the device does not support statistics reporting;

  • The statistics parameter is null or has a length of 0 (zero); or

  • The specified statistics category is invalid.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosCommon Class
PosCommon Members
Microsoft.PointOfService Namespace
CapStatisticsReporting