Share via


PinPad.EnablePinEntry Method

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

Usage

'Usage
Dim pinPad1 As PinPad
pinPad1.EnablePinEntry()

Syntax

'Declaration
Public MustOverride Sub EnablePinEntry()
public abstract void EnablePinEntry();
public: abstract Void EnablePinEntry();
public abstract void EnablePinEntry();
public abstract function EnablePinEntry() : Void;

Remarks

The application calls EnablePinEntry to start PIN entry at the PIN pad device. When EnablePinEntry is called, the base class sets the PinEntryEnabled property to TRUE.

When the user has completed the PIN entry operation (either by entering their PIN or by hitting Cancel), the service object calls the ExitPinEntry protected method of the PinPadBase class. ExitPinEntry fires a DataEvent event to provide the encrypted PIN to the application (when the DataEventEnabled property is set to TRUE). In addition, ExitPinEntry sets the PinEntryEnabled property to FALSE.

Note that any data the user enters at the PIN pad while the PinEntryEnabled property is set to TRUE will be supplied in encrypted form to the application and will NOT be provided to any associated PosKeyboard Class.

EnablePinEntry returns void if successful, and it can throw the following exceptions:

Value

Meaning

Disabled

The application has not called the BeginEftTransaction method prior to calling EnablePinEntry.

Busy

The PinEntryEnabled property was already set to TRUE, indicating that the PIN pad device is already performing pin entry.

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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

PinPad Class
PinPad Members
Microsoft.PointOfService Namespace
PinEntryEnabled
Prompt
BeginEftTransaction