Share via


PinPadBase Class (POS for .NET v1.12 SDK Documentation)

2/27/2008

Implements all properties and methods for supporting PIN pad devices.

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

Syntax

'Declaration
Public MustInherit Class PinPadBase
    Inherits PinPadBasic
public abstract class PinPadBase : PinPadBasic
public ref class PinPadBase abstract : public PinPadBasic
public abstract class PinPadBase extends PinPadBasic
public abstract class PinPadBase extends PinPadBasic

Remarks

The PinPadBase class derives from the PinPadBasic class and implements all properties and methods for support of PIN pad devices. When deriving from PinPadBase, service objects should implement the CheckHealth and DirectIO methods. In addition, they should set all Cap~ properties and implement all ~Impl methods.

PinPadBase class provides a protected method, ExitPinEntryMode. Service objects should call this method to signal to the LineDisplayBase class when PIN entry is complete. When ExitPinEntryMode is called, LineDisplayBase class will update appropriate statistics and queue the appropriate event to the application, based on the value of the status parameter.

The PinPadBase class provides the core functionality for opening, claiming, and enabling PIN pad devices. Typically, though, service objects will want to override these methods to add their own custom processing. (An example would be to update device statistics during the Open method, or to bring the device online when the application enables it.) When overriding these methods, the service object must call the base class implementation.

Inheritance Hierarchy

System.Object
   Microsoft.PointOfService.PosDevice
     Microsoft.PointOfService.PosCommon
       Microsoft.PointOfService.PinPad
         Microsoft.PointOfService.BasicServiceObjects.PinPadBasic
          Microsoft.PointOfService.BaseServiceObjects.PinPadBase

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

PinPadBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace