PosCommon.CheckHealth Method

2/27/2008

Tests the state of a device.

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

Syntax

'Declaration
Public MustOverride Function CheckHealth ( _
    level As HealthCheckLevel _
) As String

public abstract string CheckHealth (
    HealthCheckLevel level
)

public:
virtual String^ CheckHealth (
    HealthCheckLevel level
) abstract

public abstract String CheckHealth (
    HealthCheckLevel level
)

public abstract function CheckHealth (
    level : HealthCheckLevel
) : String

Parameters

• level
  Indicates the type of health check to be performed on the device. Possible values are defined by the HealthCheckLevel enumeration.

Remarks

CheckHealth is always performed synchronously. The Service Object returns a string that indicates the health level and updates the CheckHealthText property.

CheckHealth may throw a PosControlException exception with the following ErrorCodes.

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
HealthCheckLevel Enumeration
CheckHealthText