Share via

PinPadBase.ExitPinEntryMode Method (PinEntryStatus, String, String) (POS for .NET v1.14 SDK Documentation)

  • Article

3/2/2014

Called by the service object to exit PIN entry mode.

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

Syntax

'Declaration
Protected Sub ExitPinEntryMode ( _
    status As PinEntryStatus, _
    encryptedPin As String, _
    additionalSecurityInformation As String _
)

protected void ExitPinEntryMode (
    PinEntryStatus status,
    string encryptedPin,
    string additionalSecurityInformation
)

protected:
void ExitPinEntryMode (
    PinEntryStatus status, 
    String^ encryptedPin, 
    String^ additionalSecurityInformation
)

protected void ExitPinEntryMode (
    PinEntryStatus status, 
    String encryptedPin, 
    String additionalSecurityInformation
)

protected function ExitPinEntryMode (
    status : PinEntryStatus, 
    encryptedPin : String, 
    additionalSecurityInformation : String
)

Parameters

  • status
    Contains the current status of PIN entry. Possible values are defined by the PinEntryStatus enumerator.
  • encryptedPin
    If status is set to Success, encryptedPin should contain the encrypted data for the PIN that has been entered; otherwise, it should be set to null.
  • additionalSecurityInformation
    If status is set to Success, additionalSecurityInformation should contain any pertinent additional security information; otherwise, it should be set to null.

Remarks

Called by the service object to exit PIN entry mode. Calling ExitPinEntryMode causes the PinPadBase class to queue either a DataEvent event or an ErrorEvent event, depending on the value of the status parameter.

  • If status is set to PinEntryStatus.Success, the PinPadBase class increments the StatisticValidPINEntryCount statistic and queues a DataEvent event containing the encrypted PIN and the any additional security information;

  • If status is set to PinEntryStatus.Cancel, the PinPadBase class queues a DataEvent event indicating the cancellation;

  • If status is set to PinEntryStatus.Timeout, the PinPadBase class queues a DataEvent event indicating the timeout;

  • If status is set to PinEntryStatus.BadKey, the PinPadBase class queues an ErrorEvent event and increments the StatisticInvalidPINEntryCount statistic.

The PinPadBase class sets the PinEntryEnabled property to false.

ExitPinEntryMode may throw a PosControlException with the following value:

Value

Meaning

Illegal

The status parameter doesn’t match any of the values listed above.

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