Share via

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

  • Article

2/27/2008

Specifies the language in which the message specified by the Prompt property will be displayed, as defined by the CultureInfo .NET Framework class.

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

Syntax

'Declaration
Public Overrides Property PromptLanguage As CultureInfo

public override CultureInfo PromptLanguage { get; set; }

public:
virtual property CultureInfo^ PromptLanguage {
    CultureInfo^ get () override;
    void set (CultureInfo^ value) override;
}

/** @property */
public CultureInfo get_PromptLanguage ()

/** @property */
public void set_PromptLanguage (CultureInfo value)

public override function get PromptLanguage () : CultureInfo

public override function set PromptLanguage (value : CultureInfo)

Remarks

The PinPadBase class verifies that the PIN pad device has been opened, then retrieves or sets the value of PinPadProperties.PromptLanguage. If an attempt is made to set PromptLanguage and the CapLanguage property is set to PinPadLanguage.None, the PinPadProperties class throws a PosControlException exception with ErrorCode set to ErrorCode.Illegal.

Accessing PromptLanguage may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Busy

The CapLanguage property is set to PinPadLanguage.PinRestricted and the PinEntryProperty is set to true; PIN entry is currently enabled.

Illegal

One of the following conditions occurred:The application tried to set PromptLanguage to a value that doesn’t exist in the AvailableLanguagesList property; orOnly one language is supported, and it is not the language specified.

PromptLanguage is initialized to CultureInfo.CurrentCulture by the PinPadProperties class.

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.PromptLanguage Property
PinPadLanguage Enumeration
PinPad.CapLanguage Property
PinPad.AvailableLanguagesList Property