Share via

PinPadBase.AvailablePromptsList Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Holds a comma-separated string of supported values for the Prompt property.

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

Syntax

'Declaration
Public Overrides ReadOnly Property AvailablePromptsList As PinPadMessage()

public override PinPadMessage[] AvailablePromptsList { get; }

public:
virtual property array<PinPadMessage>^ AvailablePromptsList {
    array<PinPadMessage>^ get () override;
}

/** @property */
public PinPadMessage[] get_AvailablePromptsList ()

public override function get AvailablePromptsList () : PinPadMessage[]

Remarks

Possible values are defined by the PinPadMessage enumeration.

The PinPadBase class verifies that the PIN pad device has been opened, then retrieves the value of PinPadProperties.AvailablePromptsList.

AvailablePromptsList is initialized to an empty PinPadMessage array by the PinPadProperties class. If the service object attempts to set AvailablePromptsList to Null, the PinPadProperties class throws a PosControlException exception with ErrorCode set to ErrorCode.Illegal.

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.AvailablePromptsList Property
PinPadMessage Enumeration