Share via

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

  • Article

2/27/2008

Indicates the language of pre-defined messages for the PIN pad device (for example, English, French, Arabic, and so on).

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

Syntax

'Declaration
Public Overrides ReadOnly Property CapLanguage As PinPadLanguage

public override PinPadLanguage CapLanguage { get; }

public:
virtual property PinPadLanguage CapLanguage {
    PinPadLanguage get () override;
}

/** @property */
public PinPadLanguage get_CapLanguage ()

public override function get CapLanguage () : PinPadLanguage

Remarks

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

Value

Meaning

None

The PIN pad supports no pre-defined prompt messages. CapLanguage will be set to this value if the CapDisplay property is set to PinPadDisplay.RestrictedOrder. If the application tries to set the value of the PromptLanguage property, the service object sets the ErrorCode property to Illegal.

One

The PIN pad supports pre-defined prompt messages in one language. If the application tries to set the value of the PromptLanguage property, the service object will set the ErrorCode property to Illegal.

PinRestricted

The PIN pad cannot change prompt languages during PIN entry. The application must set the PromptLanguage property to the desired value before calling the EnablePinEntry method. Attempting to set the value of the PromptLanguage while the PinEntryEnabled property is set to true will cause the service object to set the ErrorCode property to Busy.

Unrestricted

The application can change the language of pre-defined prompt messages at any time, and the currently displayed message will change immediately.

CapLanguage is set by the service object, based on the capability of the device.

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

CapLanguage is initialized to PinPadLanguage.None by the PinPadProperties class. The service object should then update CapLanguage in its Open method, based on the capability of the device. If the service object sets CapLanguage to an invalid PinPadLanguage 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.CapLanguage Property
PinPadLanguage Enumeration