RemoteOrderDisplay.ControlCursor Method

2/27/2008

Enables or disables the cursor for the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub ControlCursor ( _
    units As DeviceUnits, _
    cursorType As VideoCursorType _
)

public abstract void ControlCursor (
    DeviceUnits units,
    VideoCursorType cursorType
)

public:
virtual void ControlCursor (
    DeviceUnits units, 
    VideoCursorType cursorType
) abstract

public abstract void ControlCursor (
    DeviceUnits units, 
    VideoCursorType cursorType
)

public abstract function ControlCursor (
    units : DeviceUnits, 
    cursorType : VideoCursorType
)

When the cursorType is Off, the cursor is disabled; otherwise, the cursor is enabled as the requested cursor type.

If the video unit cannot support the requested cursor type, the service object uses the next closest cursor type.

The cursorType attribute is taken from the current cursor location.

ControlCursor may cause a PosControlException to be thrown with the following ErrorCode:

Value	Description
Failure	An error occurred while communicating with one of the video units specified by units. The ErrorUnits and ErrorString properties are updated before return.

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.