Share via


PosCommon.RetrieveStatistic Method

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

Usage

'Usage
Dim statistic As String
Dim returnValue As String
Dim posCommon1 As PosCommon
returnValue = posCommon1.RetrieveStatistic(statistic)

Syntax

'Declaration
Public MustOverride Function RetrieveStatistic( _
    ByVal statistic As String _
) As String
public abstract string RetrieveStatistic(
    string statistic
);
public: abstract String^ RetrieveStatistic(
    String^ statistic
);
public abstract System.String RetrieveStatistic(
    System.String statistic
);
public abstract function RetrieveStatistic(
     statistic : String
) : String;

Parameters

  • statistic
    Specifies the statistic to be retrieved.

Remarks

The application calls RetrieveStatistic to retrieve the specified device statistic.

RetrieveStatistic is always executed synchronously.

RetrieveStatistic returns the requested statistic if successful, and it can throw the following exception:

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 statistic parameter is null or has a length of 0 (zero); or

  • The specified statistic doesn’t exist.

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