Share via

LineDisplayBase.ReadCharacterAtCursor Method

  • Article

2/27/2008

Reads the currently displayed character at the cursor position.

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

Syntax

'Declaration
Public Overrides Function ReadCharacterAtCursor As Integer

public override int ReadCharacterAtCursor ()

public:
virtual int ReadCharacterAtCursor () override

public int ReadCharacterAtCursor ()

public override function ReadCharacterAtCursor () : int

Remarks

The LineDisplayBase class ensures that the line display device has been opened, claimed, and enabled.

ReadCharacterAtCursor returns the displayed character from the current window if successful, and it may throw a PosControlException with the following ErrorCodes:

Value

Meaning

Illegal

The CapReadBack property is set to DisplayReadBack.None;The current value of CursorRow is less than zero or greater than the window height; orThe current value of CursorColumn is less than zero or greater than the window width.

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

LineDisplayBase Class
LineDisplayBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplay.CapReadBack Property
LineDisplay.ReadCharacterAtCursor Method