PinPad.Prompt Property

2/27/2008

Holds a pre-defined message to be displayed on the PIN Pad.

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

Syntax

'Declaration
Public MustOverride Property Prompt As PinPadMessage

public abstract PinPadMessage Prompt { get; set; }

public:
virtual property PinPadMessage Prompt {
    PinPadMessage get () abstract;
    void set (PinPadMessage value) abstract;
}

/** @property */
public abstract PinPadMessage get_Prompt ()

/** @property */
public abstract void set_Prompt (PinPadMessage value)

public abstract function get Prompt () : PinPadMessage

public abstract function set Prompt (value : PinPadMessage)

Remarks

Prompt identifies a pre-defined message for the application to display on the PIN pad device. Prompt is used if the CapDisplay property is set to PinPadDisplay.RestrictedList or PinPadDisplay.RestrictedOrder. Prompt is also used during PIN entry if CapDisplay is set to PinPadDisplay.PinRestricted. The AvailablePromptsList property lists the values that the service object will accept for Prompt. These values are defined by the PinPadMessage enumeration.

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

Value	Meaning
Illegal	The application tried to set Prompt to a value that isn’t in the AvailablePromptsList property.

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

PinPad Class
PinPad Members
Microsoft.PointOfService Namespace
PromptLanguage
PinPad.CapDisplay Property
PinPad.AvailablePromptsList Property
PinPadMessage