Share via

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

  • Article

3/2/2014

The PinPadBase class calls UpdateKeyImpl from its UpdateKey method.

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

Syntax

'Declaration
Protected MustOverride Sub UpdateKeyImpl ( _
    keyNumber As Integer, _
    key As String _
)

protected abstract void UpdateKeyImpl (
    int keyNumber,
    string key
)

protected:
virtual void UpdateKeyImpl (
    int keyNumber, 
    String^ key
) abstract

protected abstract void UpdateKeyImpl (
    int keyNumber, 
    String key
)

protected abstract function UpdateKeyImpl (
    keyNumber : int, 
    key : String
)

Parameters

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

Remarks

The PinPadBase class calls UpdateKeyImpl from its UpdateKey method. UpdateKeyImpl must be implemented by the service object. Before calling the UpdateKeyImpl, the PinPadBase class ensures that the following is true:

  • The PIN pad has been opened, claimed, and enabled; and

  • The BeginEftTransaction method has been called and the device is in EFT Transaction Mode.

If these validations succeed, the PinPadBase class calls UpdateKeyImpl. If any of the above conditions aren’t met, the PinPadBase class throws an exception.

If either of the parameter values is invalid, or if the currently selected PIN Pad Management system doesn’t support the UpdateKey method, the service object should return the appropriate exception to the PinPadBase class.

The service object should throw PosControlException exceptions when errors occur.

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.UpdateKey Method
PinPadBase.UpdateKey Method