PosCommon.RetrieveStatistics Method (StatisticCategories)

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

Usage

'Usage
Dim statistics As StatisticCategories
Dim returnValue As String
Dim posCommon1 As PosCommon
returnValue = posCommon1.RetrieveStatistics(statistics)

Syntax

'Declaration
Overloads Public MustOverride Function RetrieveStatistics( _
    ByVal statistics As StatisticCategories _
) As String

public abstract string RetrieveStatistics(
    StatisticCategories statistics
);

public: abstract String^ RetrieveStatistics(
    StatisticCategories^ statistics
);

public abstract System.String RetrieveStatistics(
    StatisticCategories statistics
);

public abstract function RetrieveStatistics(
     statistics : StatisticCategories
) : String;

Parameters

• statistics
  Contains the category of statistics the application wishes to retrieve. Possible values are defined by the StatisticsCategories enumeration.

Remarks

Retrieves the statistics for the specified category.

RetrieveStatistics is always executed synchronously.

RetrieveStatistics returns a string of statistics if successful, and it can throw the following exceptions:

Value	Meaning
Illegal	One of the following conditions has occurred: The CapStatisticsReporting property is set to FALSE, indicating that the device doesn’t 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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

PosCommon Class
PosCommon Members
Microsoft.PointOfService Namespace
CapStatisticsReporting