Share via

PinPadBase.UpdateKey Method (POS for .NET v1.14 SDK Documentation)

  • Article

3/2/2014

Provides a new encryption key to the PIN pad service object for those PIN Pad Management Systems in which new key values are sent to the terminal as a field in standard messages from the EFT Transaction Host.

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

Syntax

'Declaration
Public Overrides Sub UpdateKey ( _
    keyNumber As Integer, _
    key As String _
)

public override void UpdateKey (
    int keyNumber,
    string key
)

public:
virtual void UpdateKey (
    int keyNumber, 
    String^ key
) override

public void UpdateKey (
    int keyNumber, 
    String key
)

public override function UpdateKey (
    keyNumber : int, 
    key : String
)

Parameters

  • keyNumber
    Contains a key number.
  • key
    Contains a Hex-ASCII value for a new key.

Remarks

The PinPadBase class verifies that the application has opened, claimed, and enabled the device. UpdateKey may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Disabled

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

Illegal

One of the following conditions occurred:

  • The selected PIN Pad Management System does not support UpdateKey;

  • The keyNumber parameter specifies an unacceptable key number; or

  • The key parameter contains a bad key (not Hex-ASCII or wrong length or bad parity).

Otherwise, it calls the UpdateKeyImpl protected method.

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
UpdateKeyImpl
PinPad.UpdateKey Method