PinPadBase.CapDisplay Property (POS for .NET v1.12 SDK Documentation)

2/27/2008

Indicates the operations that the application can perform on the PIN pad display.

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

Syntax

'Declaration
Public Overrides ReadOnly Property CapDisplay As PinPadDisplay

public override PinPadDisplay CapDisplay { get; }

public:
virtual property PinPadDisplay CapDisplay {
    PinPadDisplay get () override;
}

/** @property */
public PinPadDisplay get_CapDisplay ()

public override function get CapDisplay () : PinPadDisplay

Remarks

Possible values are defined by the PinPadDisplay enumeration. Values are:

Value	Meaning
Unrestricted	The application can use the PIN pad’s display in an unrestricted manner to display messages. The associated LineDisplay Class is the interface to the PIN pad’s display; the application must call LineDisplay methods to manipulate the display.
PinRestricted	The application can use the PIN pad’s display in an unrestricted manner except during PIN entry. The PIN pad will display a pre-defined message during PIN entry. If the application attempts to use the associated line display while PIN entry is enabled, the line display’s service object will set the ErrorCode property to Busy.
RestrictedList	The application cannot specify the text of messages to display; it can only select from a list of pre-defined messages. There is no associated line display object.
RestrictedOrder	The application cannot specify the text of messages to display; it can only select from a list of pre-defined messages. The selections must occur in a pre-defined order. There is no associated line display object.
None	The PIN pad device in use does not have a display.

The PinPadBase class verifies that the PIN pad device has been opened, then retrieves the value of PinPadProperties.CapDisplay.

CapDisplay is initialized to PinPadDisplay.None by the PinPadProperties class. The service object should then update CapDisplay in its Open method, based on the capability of the device. If the service object sets CapDisplay to an invalid PinPadDisplay value, the PinPadProperties class throws a PosControlException exception with ErrorCode set to ErrorCode.Illegal.

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 Class
PinPadBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
PinPad.CapDisplay Property
PinPadDisplay Enumeration